Class VmImage.Builder (1.41.0)

public static final class VmImage.Builder extends GeneratedMessageV3.Builder<VmImage.Builder> implements VmImageOrBuilder

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Protobuf type google.cloud.notebooks.v2.VmImage

Implements

VmImageOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VmImage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VmImage.Builder
Overrides

build()

public VmImage build()
Returns
Type Description
VmImage

buildPartial()

public VmImage buildPartial()
Returns
Type Description
VmImage

clear()

public VmImage.Builder clear()
Returns
Type Description
VmImage.Builder
Overrides

clearFamily()

public VmImage.Builder clearFamily()

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VmImage.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VmImage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VmImage.Builder
Overrides

clearImage()

public VmImage.Builder clearImage()
Returns
Type Description
VmImage.Builder

clearName()

public VmImage.Builder clearName()

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VmImage.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VmImage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VmImage.Builder
Overrides

clearProject()

public VmImage.Builder clearProject()

Required. The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

string project = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
VmImage.Builder

This builder for chaining.

clone()

public VmImage.Builder clone()
Returns
Type Description
VmImage.Builder
Overrides

getDefaultInstanceForType()

public VmImage getDefaultInstanceForType()
Returns
Type Description
VmImage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFamily()

public String getFamily()

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The family.

getFamilyBytes()

public ByteString getFamilyBytes()

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for family.

getImageCase()

public VmImage.ImageCase getImageCase()
Returns
Type Description
VmImage.ImageCase

getName()

public String getName()

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getProject()

public String getProject()

Required. The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

string project = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Required. The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

string project = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for project.

hasFamily()

public boolean hasFamily()

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the family field is set.

hasName()

public boolean hasName()

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the name field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VmImage other)

public VmImage.Builder mergeFrom(VmImage other)
Parameter
Name Description
other VmImage
Returns
Type Description
VmImage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VmImage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VmImage.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VmImage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VmImage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VmImage.Builder
Overrides

setFamily(String value)

public VmImage.Builder setFamily(String value)

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The family to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

setFamilyBytes(ByteString value)

public VmImage.Builder setFamilyBytes(ByteString value)

Optional. Use this VM image family to find the image; the newest image in this family will be used.

string family = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for family to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VmImage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VmImage.Builder
Overrides

setName(String value)

public VmImage.Builder setName(String value)

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

setNameBytes(ByteString value)

public VmImage.Builder setNameBytes(ByteString value)

Optional. Use VM image name to find the image.

string name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

setProject(String value)

public VmImage.Builder setProject(String value)

Required. The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

string project = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The project to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public VmImage.Builder setProjectBytes(ByteString value)

Required. The name of the Google Cloud project that this VM image belongs to. Format: {project_id}

string project = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for project to set.

Returns
Type Description
VmImage.Builder

This builder for chaining.

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

public VmImage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VmImage.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final VmImage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VmImage.Builder
Overrides