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 |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POST_STARTUP_SCRIPT_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VM_IMAGE_FIELD_NUMBER
public static final int VM_IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Environment getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Environment.Builder newBuilder()
newBuilder(Environment prototype)
public static Environment.Builder newBuilder(Environment prototype)
public static Environment parseDelimitedFrom(InputStream input)
public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Environment parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Environment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(CodedInputStream input)
public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(InputStream input)
public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Environment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Environment> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getContainerImage()
public ContainerImage getContainerImage()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.ContainerImage container_image = 7;
getContainerImageOrBuilder()
public ContainerImageOrBuilder getContainerImageOrBuilder()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.ContainerImage container_image = 7;
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 |
|---|
| Type | Description |
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];
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()
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.
|
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()
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Environment> getParserForType()
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 |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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 |
|---|
| Type | Description |
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;
hasContainerImage()
public boolean hasContainerImage()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.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.v1.VmImage vm_image = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the vmImage field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Environment.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Environment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
