Class Environment.Builder (1.17.0)

Version 1.17.0

• 1.51.0 (latest)
• 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 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.v1beta1.Environment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.Builder

Implements

EnvironmentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Environment build()

Returns
Type	Description
Environment

buildPartial()

public Environment buildPartial()

Returns
Type	Description
Environment

clear()

public Environment.Builder clear()

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContainerImage()

public Environment.Builder clearContainerImage()

Use a container image to start the notebook instance.

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

Returns
Type	Description
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
Type	Description
Environment.Builder

clearDescription()

public Environment.Builder clearDescription()

A brief description of this environment.

string description = 3;

Returns
Type	Description
Environment.Builder	This builder for chaining.

clearDisplayName()

public Environment.Builder clearDisplayName()

Display name of this environment for the UI.

string display_name = 2;

Returns
Type	Description
Environment.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Environment.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearImageType()

public Environment.Builder clearImageType()

Returns
Type	Description
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
Type	Description
Environment.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
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.v1beta1.VmImage vm_image = 6;

Returns
Type	Description
Environment.Builder

clone()

public Environment.Builder clone()

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getContainerImage()

public ContainerImage getContainerImage()

Use a container image to start the notebook instance.

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

Returns
Type	Description
ContainerImage	The containerImage.

getContainerImageBuilder()

public ContainerImage.Builder getContainerImageBuilder()

Use a container image to start the notebook instance.

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

Returns
Type	Description
ContainerImage.Builder

getContainerImageOrBuilder()

public ContainerImageOrBuilder getContainerImageOrBuilder()

Use a container image to start the notebook instance.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()

Returns
Type	Description
Environment

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
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
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.

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.

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.

getVmImageBuilder()

public VmImage.Builder getVmImageBuilder()

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

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

Returns
Type	Description
VmImage.Builder

getVmImageOrBuilder()

public VmImageOrBuilder getVmImageOrBuilder()

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

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

Returns
Type	Description
VmImageOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeContainerImage(ContainerImage value)

public Environment.Builder mergeContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
Name	Description
value	ContainerImage

Returns
Type	Description
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
Name	Description
value	Timestamp

Returns
Type	Description
Environment.Builder

mergeFrom(Environment other)

public Environment.Builder mergeFrom(Environment other)

Parameter
Name	Description
other	Environment

Returns
Type	Description
Environment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Environment.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Environment.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVmImage(VmImage value)

public Environment.Builder mergeVmImage(VmImage value)

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

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

Parameter
Name	Description
value	VmImage

Returns
Type	Description
Environment.Builder

setContainerImage(ContainerImage value)

public Environment.Builder setContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
Name	Description
value	ContainerImage

Returns
Type	Description
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.v1beta1.ContainerImage container_image = 7;

Parameter
Name	Description
builderForValue	ContainerImage.Builder

Returns
Type	Description
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
Name	Description
value	Timestamp

Returns
Type	Description
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
Name	Description
builderForValue	Builder

Returns
Type	Description
Environment.Builder

setDescription(String value)

public Environment.Builder setDescription(String value)

A brief description of this environment.

string description = 3;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
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
Name	Description
value	String The displayName to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Environment.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
value	String The name to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
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
Name	Description
value	String The postStartupScript to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for postStartupScript to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Environment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVmImage(VmImage value)

public Environment.Builder setVmImage(VmImage value)

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

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

Parameter
Name	Description
value	VmImage

Returns
Type	Description
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.v1beta1.VmImage vm_image = 6;

Parameter
Name	Description
builderForValue	VmImage.Builder

Returns
Type	Description
Environment.Builder