Class VmImage

  • All Implemented Interfaces:
    VmImageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class VmImage
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VmImage.Builder
      Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
      static class  VmImage.ImageCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FAMILY_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      static int PROJECT_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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];
        Specified by:
        getProject in interface VmImageOrBuilder
        Returns:
        The project.
      • getProjectBytes

        public com.google.protobuf.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];
        Specified by:
        getProjectBytes in interface VmImageOrBuilder
        Returns:
        The bytes for project.
      • hasName

        public boolean hasName()
         Optional. Use VM image name to find the image.
         
        string name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasName in interface VmImageOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public String getName()
         Optional. Use VM image name to find the image.
         
        string name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getName in interface VmImageOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Optional. Use VM image name to find the image.
         
        string name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNameBytes in interface VmImageOrBuilder
        Returns:
        The bytes for name.
      • 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];
        Specified by:
        hasFamily in interface VmImageOrBuilder
        Returns:
        Whether the family field is set.
      • 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];
        Specified by:
        getFamily in interface VmImageOrBuilder
        Returns:
        The family.
      • getFamilyBytes

        public com.google.protobuf.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];
        Specified by:
        getFamilyBytes in interface VmImageOrBuilder
        Returns:
        The bytes for family.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static VmImage parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VmImage parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException
      • newBuilderForType

        public VmImage.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public VmImage.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected VmImage.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static VmImage getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<VmImage> parser()
      • getParserForType

        public com.google.protobuf.Parser<VmImage> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public VmImage getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder