Class VmImage.Builder (1.34.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public VmImage build()
Returns
TypeDescription
VmImage

buildPartial()

public VmImage buildPartial()
Returns
TypeDescription
VmImage

clear()

public VmImage.Builder clear()
Returns
TypeDescription
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
TypeDescription
VmImage.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearImage()

public VmImage.Builder clearImage()
Returns
TypeDescription
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
TypeDescription
VmImage.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VmImage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
VmImage.Builder

This builder for chaining.

clone()

public VmImage.Builder clone()
Returns
TypeDescription
VmImage.Builder
Overrides

getDefaultInstanceForType()

public VmImage getDefaultInstanceForType()
Returns
TypeDescription
VmImage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for family.

getImageCase()

public VmImage.ImageCase getImageCase()
Returns
TypeDescription
VmImage.ImageCase

getName()

public String getName()

Optional. Use VM image name to find the image.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the name field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(VmImage other)

public VmImage.Builder mergeFrom(VmImage other)
Parameter
NameDescription
otherVmImage
Returns
TypeDescription
VmImage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VmImage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The family to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for family to set.

Returns
TypeDescription
VmImage.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VmImage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueString

The project to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
VmImage.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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