com.google.cloud.notebooks.v1beta1

Interface EnvironmentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Environment, Environment.Builder

public interface EnvironmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ContainerImage	getContainerImage() Use a container image to start the notebook instance.
ContainerImageOrBuilder	getContainerImageOrBuilder() Use a container image to start the notebook instance.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() A brief description of this environment.
com.google.protobuf.ByteString	getDescriptionBytes() A brief description of this environment.
String	getDisplayName() Display name of this environment for the UI.
com.google.protobuf.ByteString	getDisplayNameBytes() Display name of this environment for the UI.
Environment.ImageTypeCase	getImageTypeCase()
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getPostStartupScript() Path to a Bash script that automatically runs after a notebook instance fully boots up.
com.google.protobuf.ByteString	getPostStartupScriptBytes() Path to a Bash script that automatically runs after a notebook instance fully boots up.
VmImage	getVmImage() Use a Compute Engine VM image to start the notebook instance.
VmImageOrBuilder	getVmImageOrBuilder() Use a Compute Engine VM image to start the notebook instance.
boolean	hasContainerImage() Use a container image to start the notebook instance.
boolean	hasCreateTime() Output only.
boolean	hasVmImage() Use a Compute Engine VM image to start the notebook instance.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String 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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

String getDisplayName()

 Display name of this environment for the UI.
 

string display_name = 2;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Display name of this environment for the UI.
 

string display_name = 2;

Returns:

The bytes for displayName.

getDescription

String getDescription()

 A brief description of this environment.
 

string description = 3;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 A brief description of this environment.
 

string description = 3;

Returns:

The bytes for description.

hasVmImage

boolean hasVmImage()

 Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;

Returns:

Whether the vmImage field is set.

getVmImage

VmImage getVmImage()

 Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;

Returns:

The vmImage.

getVmImageOrBuilder

VmImageOrBuilder getVmImageOrBuilder()

 Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.VmImage vm_image = 6;

hasContainerImage

boolean hasContainerImage()

 Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;

Returns:

Whether the containerImage field is set.

getContainerImage

ContainerImage getContainerImage()

 Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;

Returns:

The containerImage.

getContainerImageOrBuilder

ContainerImageOrBuilder getContainerImageOrBuilder()

 Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 7;

getPostStartupScript

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:

The postStartupScript.

getPostStartupScriptBytes

com.google.protobuf.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:

The bytes for postStartupScript.

hasCreateTime

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:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.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:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time at which this environment was created.
 

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getImageTypeCase

Environment.ImageTypeCase getImageTypeCase()