Package com.google.cloud.baremetalsolution.v2

Interface InstanceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance, Instance.Builder
    public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getId

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

      • getIdBytes

        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];
        Returns:
        The bytes for id.

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create a time stamp.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update a time stamp.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMachineType

        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];
        Returns:
        The machineType.

      • getMachineTypeBytes

        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];
        Returns:
        The bytes for machineType.

      • getStateValue

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

      • getState

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

      • getHyperthreadingEnabled

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

      • getLabelsCount

        int getLabelsCount()
         Labels as key value pairs.
        map<string, string> labels = 7;

      • containsLabels

        boolean containsLabels​(String key)
         Labels as key value pairs.
        map<string, string> labels = 7;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels as key value pairs.
        map<string, string> labels = 7;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels as key value pairs.
        map<string, string> labels = 7;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels as key value pairs.
        map<string, string> labels = 7;

      • getLunsList

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

      • getLuns

        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];

      • getLunsCount

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

      • getLunsOrBuilderList

        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];

      • getLunsOrBuilder

        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];

      • getVolumesList

        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];

      • getVolumes

        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];

      • getVolumesCount

        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];

      • getVolumesOrBuilderList

        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];

      • getVolumesOrBuilder

        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];

      • getNetworksList

        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];

      • getNetworks

        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];

      • getNetworksCount

        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];

      • getNetworksOrBuilderList

        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];

      • getNetworksOrBuilder

        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];

      • getInteractiveSerialConsoleEnabled

        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];
        Returns:
        The interactiveSerialConsoleEnabled.

      • getOsImage

        String getOsImage()
         The OS image currently installed on the server.
        string os_image = 12;
        Returns:
        The osImage.

      • getOsImageBytes

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

      • getPod

        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];
        Returns:
        The pod.

      • getPodBytes

        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];
        Returns:
        The bytes for pod.

      • getNetworkTemplate

        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) = { ... }
        Returns:
        The networkTemplate.

      • getNetworkTemplateBytes

        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) = { ... }
        Returns:
        The bytes for networkTemplate.

      • getLogicalInterfacesList

        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;

      • getLogicalInterfaces

        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;

      • getLogicalInterfacesCount

        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;

      • getLogicalInterfacesOrBuilderList

        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;

      • getLogicalInterfacesOrBuilder

        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;

      • getLoginInfo

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

      • getLoginInfoBytes

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

      • getWorkloadProfileValue

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

      • getWorkloadProfile

        WorkloadProfile getWorkloadProfile()
         The workload profile for the instance.
        .google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
        Returns:
        The workloadProfile.

      • getFirmwareVersion

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

      • getFirmwareVersionBytes

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