Class Environment (1.34.0)

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.v1.Environment

Static Fields

CONTAINER_IMAGE_FIELD_NUMBER

public static final int CONTAINER_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

POST_STARTUP_SCRIPT_FIELD_NUMBER

public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

VM_IMAGE_FIELD_NUMBER

public static final int VM_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Environment getDefaultInstance()
Returns
TypeDescription
Environment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Environment.Builder newBuilder()
Returns
TypeDescription
Environment.Builder

newBuilder(Environment prototype)

public static Environment.Builder newBuilder(Environment prototype)
Parameter
NameDescription
prototypeEnvironment
Returns
TypeDescription
Environment.Builder

parseDelimitedFrom(InputStream input)

public static Environment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Environment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Environment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Environment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Environment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Environment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Environment> parser()
Returns
TypeDescription
Parser<Environment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContainerImage()

public ContainerImage getContainerImage()

Use a container image to start the notebook instance.

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

Returns
TypeDescription
ContainerImage

The containerImage.

getContainerImageOrBuilder()

public ContainerImageOrBuilder getContainerImageOrBuilder()

Use a container image to start the notebook instance.

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

Returns
TypeDescription
ContainerImageOrBuilder

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
TypeDescription
Timestamp

The createTime.

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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
TypeDescription
Environment

getDescription()

public String getDescription()

A brief description of this environment.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A brief description of this environment.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Display name of this environment for the UI.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name of this environment for the UI.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getImageTypeCase()

public Environment.ImageTypeCase getImageTypeCase()
Returns
TypeDescription
Environment.ImageTypeCase

getName()

public 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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Environment> getParserForType()
Returns
TypeDescription
Parser<Environment>
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
TypeDescription
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
TypeDescription
ByteString

The bytes for postStartupScript.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVmImage()

public VmImage getVmImage()

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

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

Returns
TypeDescription
VmImage

The vmImage.

getVmImageOrBuilder()

public VmImageOrBuilder getVmImageOrBuilder()

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

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

Returns
TypeDescription
VmImageOrBuilder

hasContainerImage()

public boolean hasContainerImage()

Use a container image to start the notebook instance.

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

Returns
TypeDescription
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
TypeDescription
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.v1.VmImage vm_image = 6;

Returns
TypeDescription
boolean

Whether the vmImage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Environment.Builder newBuilderForType()
Returns
TypeDescription
Environment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Environment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Environment.Builder toBuilder()
Returns
TypeDescription
Environment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException