Class VmImage (1.25.0)

public final class VmImage extends GeneratedMessageV3 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 Fields

FAMILY_FIELD_NUMBER

public static final int FAMILY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static VmImage getDefaultInstance()
Returns
TypeDescription
VmImage

getDescriptor()

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

newBuilder()

public static VmImage.Builder newBuilder()
Returns
TypeDescription
VmImage.Builder

newBuilder(VmImage prototype)

public static VmImage.Builder newBuilder(VmImage prototype)
Parameter
NameDescription
prototypeVmImage
Returns
TypeDescription
VmImage.Builder

parseDelimitedFrom(InputStream input)

public static VmImage parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static VmImage parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VmImage parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VmImage parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static VmImage parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static VmImage parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VmImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<VmImage> parser()
Returns
TypeDescription
Parser<VmImage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public VmImage getDefaultInstanceForType()
Returns
TypeDescription
VmImage

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.

getParserForType()

public Parser<VmImage> getParserForType()
Returns
TypeDescription
Parser<VmImage>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public VmImage.Builder newBuilderForType()
Returns
TypeDescription
VmImage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VmImage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
VmImage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public VmImage.Builder toBuilder()
Returns
TypeDescription
VmImage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException