Class Environment (0.6.2)
1.85.0 (latest)
1.83.0
1.81.0
1.80.0
1.78.0
1.76.0
1.74.0
1.73.0
1.72.0
1.71.0
1.70.0
1.68.0
1.66.0
1.65.0
1.62.0
1.61.0
1.60.0
1.58.0
1.57.0
1.56.0
1.55.0
1.54.0
1.53.0
1.52.0
1.51.0
1.50.0
1.49.0
1.47.0
1.46.0
1.45.0
1.44.0
1.43.0
1.42.0
1.41.0
1.40.0
1.39.0
1.38.0
1.37.0
1.35.0
1.34.0
1.33.0
1.32.0
1.31.0
1.30.0
1.29.0
1.28.0
1.27.0
1.26.0
1.25.0
1.22.0
1.21.0
1.20.0
1.19.0
1.18.0
1.17.0
1.16.0
1.15.0
1.14.0
1.13.0
1.12.0
1.11.0
1.10.0
1.9.0
1.7.0
1.6.0
1.5.0
1.4.0
1.3.0
1.2.0
1.1.3
1.0.6
0.6.2
public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder
Definition of a software environment that is used to start a notebook
instance.
Protobuf type google.cloud.notebooks.v1beta1.Environment
Fields
CONTAINER_IMAGE_FIELD_NUMBER
public static final int CONTAINER_IMAGE_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
POST_STARTUP_SCRIPT_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
Field Value
VM_IMAGE_FIELD_NUMBER
public static final int VM_IMAGE_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getContainerImage()
public ContainerImage getContainerImage ()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;
Returns
getContainerImageOrBuilder()
public ContainerImageOrBuilder getContainerImageOrBuilder ()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;
Returns
getCreateTime()
public Timestamp getCreateTime ()
Output only. The time at which this environment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. The time at which this environment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstance()
public static Environment getDefaultInstance ()
Returns
getDefaultInstanceForType()
public Environment getDefaultInstanceForType ()
Returns
getDescription()
public String getDescription ()
A brief description of this environment.
string description = 3;
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
A brief description of this environment.
string description = 3;
Returns
Type Description
ByteString The bytes for description.
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
getDisplayName()
public String getDisplayName ()
Display name of this environment for the UI.
string display_name = 2;
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Display name of this environment for the UI.
string display_name = 2;
Returns
Type Description
ByteString The bytes for displayName.
getImageTypeCase()
public Environment . ImageTypeCase getImageTypeCase ()
Returns
getName()
Output only. Name of this environment.
Format:
projects/{project_id}/locations/{location}/environments/{environment_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Output only. Name of this environment.
Format:
projects/{project_id}/locations/{location}/environments/{environment_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getParserForType()
public Parser<Environment> getParserForType ()
Returns
Overrides
getPostStartupScript()
public String getPostStartupScript ()
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"
string post_startup_script = 8;
Returns
Type Description
String The postStartupScript.
getPostStartupScriptBytes()
public ByteString getPostStartupScriptBytes ()
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"
string post_startup_script = 8;
Returns
Type Description
ByteString The bytes for postStartupScript.
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
getVmImage()
public VmImage getVmImage ()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;
Returns
Type Description
VmImage The vmImage.
getVmImageOrBuilder()
public VmImageOrBuilder getVmImageOrBuilder ()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;
Returns
hasContainerImage()
public boolean hasContainerImage ()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;
Returns
Type Description
boolean Whether the containerImage field is set.
hasCreateTime()
public boolean hasCreateTime ()
Output only. The time at which this environment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the createTime field is set.
hasVmImage()
public boolean hasVmImage ()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;
Returns
Type Description
boolean Whether the vmImage field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilder()
public static Environment . Builder newBuilder ()
Returns
newBuilder(Environment prototype)
public static Environment . Builder newBuilder ( Environment prototype )
Parameter
Returns
newBuilderForType()
public Environment . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public static Environment parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Environment parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Environment parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Environment parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Environment parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Environment parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Environment parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Environment parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Environment parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Environment> parser ()
Returns
toBuilder()
public Environment . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
