Class VmImage (1.53.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.v1.VmImage

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VmImage

Implements

VmImageOrBuilder

Static Fields

IMAGE_FAMILY_FIELD_NUMBER

public static final int IMAGE_FAMILY_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_NAME_FIELD_NUMBER

public static final int IMAGE_NAME_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VmImage getDefaultInstance()
Returns
Type Description
VmImage

getDescriptor()

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

newBuilder()

public static VmImage.Builder newBuilder()
Returns
Type Description
VmImage.Builder

newBuilder(VmImage prototype)

public static VmImage.Builder newBuilder(VmImage prototype)
Parameter
Name Description
prototype VmImage
Returns
Type Description
VmImage.Builder

parseDelimitedFrom(InputStream input)

public static VmImage parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VmImage parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VmImage parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VmImage parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VmImage parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VmImage parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VmImage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VmImage
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VmImage> parser()
Returns
Type Description
Parser<VmImage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public VmImage getDefaultInstanceForType()
Returns
Type Description
VmImage

getImageCase()

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

getImageFamily()

public String getImageFamily()

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

string image_family = 3;

Returns
Type Description
String

The imageFamily.

getImageFamilyBytes()

public ByteString getImageFamilyBytes()

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

string image_family = 3;

Returns
Type Description
ByteString

The bytes for imageFamily.

getImageName()

public String getImageName()

Use VM image name to find the image.

string image_name = 2;

Returns
Type Description
String

The imageName.

getImageNameBytes()

public ByteString getImageNameBytes()

Use VM image name to find the image.

string image_name = 2;

Returns
Type Description
ByteString

The bytes for imageName.

getParserForType()

public Parser<VmImage> getParserForType()
Returns
Type Description
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasImageFamily()

public boolean hasImageFamily()

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

string image_family = 3;

Returns
Type Description
boolean

Whether the imageFamily field is set.

hasImageName()

public boolean hasImageName()

Use VM image name to find the image.

string image_name = 2;

Returns
Type Description
boolean

Whether the imageName field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VmImage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VmImage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException