Class Environment.Builder

public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilder

Definition of a software environment that is used to start a notebook instance.

Protobuf type google.cloud.notebooks.v1.Environment

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Environment.Builder
Overrides

build()

public Environment build()
Returns
TypeDescription
Environment

buildPartial()

public Environment buildPartial()
Returns
TypeDescription
Environment

clear()

public Environment.Builder clear()
Returns
TypeDescription
Environment.Builder
Overrides

clearContainerImage()

public Environment.Builder clearContainerImage()

Use a container image to start the notebook instance.

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

Returns
TypeDescription
Environment.Builder

clearCreateTime()

public Environment.Builder clearCreateTime()

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

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

Returns
TypeDescription
Environment.Builder

clearDescription()

public Environment.Builder clearDescription()

A brief description of this environment.

string description = 3;

Returns
TypeDescription
Environment.Builder

This builder for chaining.

clearDisplayName()

public Environment.Builder clearDisplayName()

Display name of this environment for the UI.

string display_name = 2;

Returns
TypeDescription
Environment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Environment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Environment.Builder
Overrides

clearImageType()

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

clearName()

public Environment.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Environment.Builder
Overrides

clearPostStartupScript()

public Environment.Builder clearPostStartupScript()

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

This builder for chaining.

clearVmImage()

public Environment.Builder clearVmImage()

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

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

Returns
TypeDescription
Environment.Builder

clone()

public Environment.Builder clone()
Returns
TypeDescription
Environment.Builder
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.

getContainerImageBuilder()

public ContainerImage.Builder getContainerImageBuilder()

Use a container image to start the notebook instance.

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

Returns
TypeDescription
ContainerImage.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

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

Returns
TypeDescription
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

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.

getVmImageBuilder()

public VmImage.Builder getVmImageBuilder()

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

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

Returns
TypeDescription
VmImage.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeContainerImage(ContainerImage value)

public Environment.Builder mergeContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
NameDescription
valueContainerImage
Returns
TypeDescription
Environment.Builder

mergeCreateTime(Timestamp value)

public Environment.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Environment.Builder

mergeFrom(Environment other)

public Environment.Builder mergeFrom(Environment other)
Parameter
NameDescription
otherEnvironment
Returns
TypeDescription
Environment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Environment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Environment.Builder
Overrides

mergeVmImage(VmImage value)

public Environment.Builder mergeVmImage(VmImage value)

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

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

Parameter
NameDescription
valueVmImage
Returns
TypeDescription
Environment.Builder

setContainerImage(ContainerImage value)

public Environment.Builder setContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
NameDescription
valueContainerImage
Returns
TypeDescription
Environment.Builder

setContainerImage(ContainerImage.Builder builderForValue)

public Environment.Builder setContainerImage(ContainerImage.Builder builderForValue)

Use a container image to start the notebook instance.

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

Parameter
NameDescription
builderForValueContainerImage.Builder
Returns
TypeDescription
Environment.Builder

setCreateTime(Timestamp value)

public Environment.Builder setCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Environment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Environment.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Environment.Builder

setDescription(String value)

public Environment.Builder setDescription(String value)

A brief description of this environment.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Environment.Builder setDescriptionBytes(ByteString value)

A brief description of this environment.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setDisplayName(String value)

public Environment.Builder setDisplayName(String value)

Display name of this environment for the UI.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Environment.Builder setDisplayNameBytes(ByteString value)

Display name of this environment for the UI.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Environment.Builder
Overrides

setName(String value)

public Environment.Builder setName(String value)

Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Environment.Builder setNameBytes(ByteString value)

Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setPostStartupScript(String value)

public Environment.Builder setPostStartupScript(String value)

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;

Parameter
NameDescription
valueString

The postStartupScript to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setPostStartupScriptBytes(ByteString value)

public Environment.Builder setPostStartupScriptBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for postStartupScript to set.

Returns
TypeDescription
Environment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Environment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Environment.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Environment.Builder
Overrides

setVmImage(VmImage value)

public Environment.Builder setVmImage(VmImage value)

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

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

Parameter
NameDescription
valueVmImage
Returns
TypeDescription
Environment.Builder

setVmImage(VmImage.Builder builderForValue)

public Environment.Builder setVmImage(VmImage.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueVmImage.Builder
Returns
TypeDescription
Environment.Builder