Package com.google.cloud.baremetalsolution.v2

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     A server.
    Protobuf type google.cloud.baremetalsolution.v2.Instance
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Immutable. The resource name of this `Instance`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/instances/{instance}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. The resource name of this `Instance`.
 Resource names are schemeless URIs that follow the conventions in
 https://cloud.google.com/apis/design/resource_names.
 Format:
 `projects/{project}/locations/{location}/instances/{instance}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         Output only. An identifier for the `Instance`, generated by the backend.
        string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface InstanceOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Output only. An identifier for the `Instance`, generated by the backend.
        string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for id.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Create a time stamp.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface InstanceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Create a time stamp.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface InstanceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create a time stamp.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface InstanceOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Update a time stamp.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface InstanceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Update a time stamp.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface InstanceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update a time stamp.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface InstanceOrBuilder

      • getMachineType

        public String getMachineType()
         Immutable. The server type.
 [Available server
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getMachineType in interface InstanceOrBuilder
        Returns:
        The machineType.

      • getMachineTypeBytes

        public com.google.protobuf.ByteString getMachineTypeBytes()
         Immutable. The server type.
 [Available server
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getMachineTypeBytes in interface InstanceOrBuilder
        Returns:
        The bytes for machineType.

      • getStateValue

        public int getStateValue()
         Output only. The state of the server.
        .google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Instance.State getState()
         Output only. The state of the server.
        .google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The state.

      • getHyperthreadingEnabled

        public boolean getHyperthreadingEnabled()
         True if you enable hyperthreading for the server, otherwise false.
 The default value is false.
        bool hyperthreading_enabled = 6;
        Specified by:
        getHyperthreadingEnabled in interface InstanceOrBuilder
        Returns:
        The hyperthreadingEnabled.

      • containsLabels

        public boolean containsLabels​(String key)
         Labels as key value pairs.
        map<string, string> labels = 7;
        Specified by:
        containsLabels in interface InstanceOrBuilder

      • getLunsList

        public List<Lun> getLunsList()
         Immutable. List of LUNs associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLunsList in interface InstanceOrBuilder

      • getLunsOrBuilderList

        public List<? extends LunOrBuilder> getLunsOrBuilderList()
         Immutable. List of LUNs associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLunsOrBuilderList in interface InstanceOrBuilder

      • getLunsCount

        public int getLunsCount()
         Immutable. List of LUNs associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLunsCount in interface InstanceOrBuilder

      • getLuns

        public Lun getLuns​(int index)
         Immutable. List of LUNs associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLuns in interface InstanceOrBuilder

      • getLunsOrBuilder

        public LunOrBuilder getLunsOrBuilder​(int index)
         Immutable. List of LUNs associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLunsOrBuilder in interface InstanceOrBuilder

      • getVolumesList

        public List<Volume> getVolumesList()
         Input only. List of Volumes to attach to this Instance on creation.
 This field won't be populated in Get/List responses.
        repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getVolumesList in interface InstanceOrBuilder

      • getVolumesOrBuilderList

        public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
         Input only. List of Volumes to attach to this Instance on creation.
 This field won't be populated in Get/List responses.
        repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getVolumesOrBuilderList in interface InstanceOrBuilder

      • getVolumesCount

        public int getVolumesCount()
         Input only. List of Volumes to attach to this Instance on creation.
 This field won't be populated in Get/List responses.
        repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getVolumesCount in interface InstanceOrBuilder

      • getVolumes

        public Volume getVolumes​(int index)
         Input only. List of Volumes to attach to this Instance on creation.
 This field won't be populated in Get/List responses.
        repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getVolumes in interface InstanceOrBuilder

      • getVolumesOrBuilder

        public VolumeOrBuilder getVolumesOrBuilder​(int index)
         Input only. List of Volumes to attach to this Instance on creation.
 This field won't be populated in Get/List responses.
        repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getVolumesOrBuilder in interface InstanceOrBuilder

      • getNetworksList

        public List<Network> getNetworksList()
         Output only. List of networks associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNetworksList in interface InstanceOrBuilder

      • getNetworksOrBuilderList

        public List<? extends NetworkOrBuilder> getNetworksOrBuilderList()
         Output only. List of networks associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNetworksOrBuilderList in interface InstanceOrBuilder

      • getNetworksCount

        public int getNetworksCount()
         Output only. List of networks associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNetworksCount in interface InstanceOrBuilder

      • getNetworks

        public Network getNetworks​(int index)
         Output only. List of networks associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNetworks in interface InstanceOrBuilder

      • getNetworksOrBuilder

        public NetworkOrBuilder getNetworksOrBuilder​(int index)
         Output only. List of networks associated with this server.
        repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNetworksOrBuilder in interface InstanceOrBuilder

      • getInteractiveSerialConsoleEnabled

        public boolean getInteractiveSerialConsoleEnabled()
         Output only. True if the interactive serial console feature is enabled for
 the instance, false otherwise. The default value is false.
        bool interactive_serial_console_enabled = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getInteractiveSerialConsoleEnabled in interface InstanceOrBuilder
        Returns:
        The interactiveSerialConsoleEnabled.

      • getOsImage

        public String getOsImage()
         The OS image currently installed on the server.
        string os_image = 12;
        Specified by:
        getOsImage in interface InstanceOrBuilder
        Returns:
        The osImage.

      • getOsImageBytes

        public com.google.protobuf.ByteString getOsImageBytes()
         The OS image currently installed on the server.
        string os_image = 12;
        Specified by:
        getOsImageBytes in interface InstanceOrBuilder
        Returns:
        The bytes for osImage.

      • getPod

        public String getPod()
         Immutable. Pod name.
 Pod is an independent part of infrastructure.
 Instance can be connected to the assets (networks, volumes) allocated
 in the same pod only.
        string pod = 13 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPod in interface InstanceOrBuilder
        Returns:
        The pod.

      • getPodBytes

        public com.google.protobuf.ByteString getPodBytes()
         Immutable. Pod name.
 Pod is an independent part of infrastructure.
 Instance can be connected to the assets (networks, volumes) allocated
 in the same pod only.
        string pod = 13 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPodBytes in interface InstanceOrBuilder
        Returns:
        The bytes for pod.

      • getNetworkTemplate

        public String getNetworkTemplate()
         Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc.
 Generally, the template name follows the syntax of
 "bond<bond_mode>" or "nic".
        string network_template = 14 [(.google.api.resource_reference) = { ... }
        Specified by:
        getNetworkTemplate in interface InstanceOrBuilder
        Returns:
        The networkTemplate.

      • getNetworkTemplateBytes

        public com.google.protobuf.ByteString getNetworkTemplateBytes()
         Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc.
 Generally, the template name follows the syntax of
 "bond<bond_mode>" or "nic".
        string network_template = 14 [(.google.api.resource_reference) = { ... }
        Specified by:
        getNetworkTemplateBytes in interface InstanceOrBuilder
        Returns:
        The bytes for networkTemplate.

      • getLogicalInterfacesList

        public List<LogicalInterface> getLogicalInterfacesList()
         List of logical interfaces for the instance. The number of logical
 interfaces will be the same as number of hardware bond/nic on the chosen
 network template. For the non-multivlan configurations (for eg, existing
 servers) that use existing default network template (bondaa-bondaa), both
 the Instance.networks field and the Instance.logical_interfaces fields will
 be filled to ensure backward compatibility. For the others, only
 Instance.logical_interfaces will be filled.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 15;
        Specified by:
        getLogicalInterfacesList in interface InstanceOrBuilder

      • getLogicalInterfacesOrBuilderList

        public List<? extends LogicalInterfaceOrBuilder> getLogicalInterfacesOrBuilderList()
         List of logical interfaces for the instance. The number of logical
 interfaces will be the same as number of hardware bond/nic on the chosen
 network template. For the non-multivlan configurations (for eg, existing
 servers) that use existing default network template (bondaa-bondaa), both
 the Instance.networks field and the Instance.logical_interfaces fields will
 be filled to ensure backward compatibility. For the others, only
 Instance.logical_interfaces will be filled.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 15;
        Specified by:
        getLogicalInterfacesOrBuilderList in interface InstanceOrBuilder

      • getLogicalInterfacesCount

        public int getLogicalInterfacesCount()
         List of logical interfaces for the instance. The number of logical
 interfaces will be the same as number of hardware bond/nic on the chosen
 network template. For the non-multivlan configurations (for eg, existing
 servers) that use existing default network template (bondaa-bondaa), both
 the Instance.networks field and the Instance.logical_interfaces fields will
 be filled to ensure backward compatibility. For the others, only
 Instance.logical_interfaces will be filled.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 15;
        Specified by:
        getLogicalInterfacesCount in interface InstanceOrBuilder

      • getLogicalInterfaces

        public LogicalInterface getLogicalInterfaces​(int index)
         List of logical interfaces for the instance. The number of logical
 interfaces will be the same as number of hardware bond/nic on the chosen
 network template. For the non-multivlan configurations (for eg, existing
 servers) that use existing default network template (bondaa-bondaa), both
 the Instance.networks field and the Instance.logical_interfaces fields will
 be filled to ensure backward compatibility. For the others, only
 Instance.logical_interfaces will be filled.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 15;
        Specified by:
        getLogicalInterfaces in interface InstanceOrBuilder

      • getLogicalInterfacesOrBuilder

        public LogicalInterfaceOrBuilder getLogicalInterfacesOrBuilder​(int index)
         List of logical interfaces for the instance. The number of logical
 interfaces will be the same as number of hardware bond/nic on the chosen
 network template. For the non-multivlan configurations (for eg, existing
 servers) that use existing default network template (bondaa-bondaa), both
 the Instance.networks field and the Instance.logical_interfaces fields will
 be filled to ensure backward compatibility. For the others, only
 Instance.logical_interfaces will be filled.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 15;
        Specified by:
        getLogicalInterfacesOrBuilder in interface InstanceOrBuilder

      • getLoginInfo

        public String getLoginInfo()
         Output only. Text field about info for logging in.
        string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoginInfo in interface InstanceOrBuilder
        Returns:
        The loginInfo.

      • getLoginInfoBytes

        public com.google.protobuf.ByteString getLoginInfoBytes()
         Output only. Text field about info for logging in.
        string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLoginInfoBytes in interface InstanceOrBuilder
        Returns:
        The bytes for loginInfo.

      • getWorkloadProfileValue

        public int getWorkloadProfileValue()
         The workload profile for the instance.
        .google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
        Specified by:
        getWorkloadProfileValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for workloadProfile.

      • getWorkloadProfile

        public WorkloadProfile getWorkloadProfile()
         The workload profile for the instance.
        .google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
        Specified by:
        getWorkloadProfile in interface InstanceOrBuilder
        Returns:
        The workloadProfile.

      • getFirmwareVersion

        public String getFirmwareVersion()
         Output only. The firmware version for the instance.
        string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFirmwareVersion in interface InstanceOrBuilder
        Returns:
        The firmwareVersion.

      • getFirmwareVersionBytes

        public com.google.protobuf.ByteString getFirmwareVersionBytes()
         Output only. The firmware version for the instance.
        string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFirmwareVersionBytes in interface InstanceOrBuilder
        Returns:
        The bytes for firmwareVersion.

      • 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 Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Instance> parser()

      • getParserForType

        public com.google.protobuf.Parser<Instance> 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 Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder