public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilderDefinition of a software environment that is used to start a notebook instance.
Protobuf type google.events.cloud.notebooks.v1.Environment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.BuilderImplements
EnvironmentOrBuilderStatic 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 | |
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 | |
clearContainerImage()
public Environment.Builder clearContainerImage()Use a container image to start the notebook instance.
.google.events.cloud.notebooks.v1.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;
| 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 | |
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;
| 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 | |
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.events.cloud.notebooks.v1.VmImage vm_image = 6;
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
clone()
public Environment.Builder clone()| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
getContainerImage()
public ContainerImage getContainerImage()Use a container image to start the notebook instance.
.google.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.ContainerImage container_image = 7;
| Returns | |
|---|---|
| Type | Description |
ContainerImage.Builder | |
getContainerImageOrBuilder()
public ContainerImageOrBuilder getContainerImageOrBuilder()Use a container image to start the notebook instance.
.google.events.cloud.notebooks.v1.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;
| 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;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which this environment was created.
.google.protobuf.Timestamp create_time = 9;
| 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 | |
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;
| 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;
| 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.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.VmImage vm_image = 6;
| Returns | |
|---|---|
| Type | Description |
VmImageOrBuilder | |
hasContainerImage()
public boolean hasContainerImage()Use a container image to start the notebook instance.
.google.events.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;
| 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.events.cloud.notebooks.v1.VmImage vm_image = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the vmImage field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeContainerImage(ContainerImage value)
public Environment.Builder mergeContainerImage(ContainerImage value)Use a container image to start the notebook instance.
.google.events.cloud.notebooks.v1.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;
| 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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Environment.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
mergeVmImage(VmImage value)
public Environment.Builder mergeVmImage(VmImage value)Use a Compute Engine VM image to start the notebook instance.
.google.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.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;
| 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;
| 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
setVmImage(VmImage value)
public Environment.Builder setVmImage(VmImage value)Use a Compute Engine VM image to start the notebook instance.
.google.events.cloud.notebooks.v1.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.events.cloud.notebooks.v1.VmImage vm_image = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | VmImage.Builder |
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |