Package com.google.cloud.baremetalsolution.v2

Class InstanceConfig

  • All Implemented Interfaces:
    InstanceConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class InstanceConfig
extends com.google.protobuf.GeneratedMessageV3
implements InstanceConfigOrBuilder
     Configuration parameters for a new instance.
    Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig
    See Also:
    Serialized Form

    • Field Detail

      • INSTANCE_TYPE_FIELD_NUMBER

        public static final int INSTANCE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HYPERTHREADING_FIELD_NUMBER

        public static final int HYPERTHREADING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLIENT_NETWORK_FIELD_NUMBER

        public static final int CLIENT_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRIVATE_NETWORK_FIELD_NUMBER

        public static final int PRIVATE_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACCOUNT_NETWORKS_ENABLED_FIELD_NUMBER

        public static final int ACCOUNT_NETWORKS_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NETWORK_CONFIG_FIELD_NUMBER

        public static final int NETWORK_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NETWORK_TEMPLATE_FIELD_NUMBER

        public static final int NETWORK_TEMPLATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOGICAL_INTERFACES_FIELD_NUMBER

        public static final int LOGICAL_INTERFACES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SSH_KEY_NAMES_FIELD_NUMBER

        public static final int SSH_KEY_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getName

        public String getName()
         Output only. The name of the instance config.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface InstanceConfigOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The name of the instance config.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface InstanceConfigOrBuilder
        Returns:
        The bytes for name.

      • getId

        public String getId()
         A transient unique identifier to idenfity an instance within an
 ProvisioningConfig request.
        string id = 2;
        Specified by:
        getId in interface InstanceConfigOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         A transient unique identifier to idenfity an instance within an
 ProvisioningConfig request.
        string id = 2;
        Specified by:
        getIdBytes in interface InstanceConfigOrBuilder
        Returns:
        The bytes for id.

      • getInstanceType

        public String getInstanceType()
         Instance type.
 [Available
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string instance_type = 3;
        Specified by:
        getInstanceType in interface InstanceConfigOrBuilder
        Returns:
        The instanceType.

      • getInstanceTypeBytes

        public com.google.protobuf.ByteString getInstanceTypeBytes()
         Instance type.
 [Available
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string instance_type = 3;
        Specified by:
        getInstanceTypeBytes in interface InstanceConfigOrBuilder
        Returns:
        The bytes for instanceType.

      • getHyperthreading

        public boolean getHyperthreading()
         Whether the instance should be provisioned with Hyperthreading enabled.
        bool hyperthreading = 4;
        Specified by:
        getHyperthreading in interface InstanceConfigOrBuilder
        Returns:
        The hyperthreading.

      • getOsImage

        public String getOsImage()
         OS image to initialize the instance.
 [Available
 images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string os_image = 5;
        Specified by:
        getOsImage in interface InstanceConfigOrBuilder
        Returns:
        The osImage.

      • getOsImageBytes

        public com.google.protobuf.ByteString getOsImageBytes()
         OS image to initialize the instance.
 [Available
 images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        string os_image = 5;
        Specified by:
        getOsImageBytes in interface InstanceConfigOrBuilder
        Returns:
        The bytes for osImage.

      • hasClientNetwork

        @Deprecated
public boolean hasClientNetwork()
        Deprecated.
        google.cloud.baremetalsolution.v2.InstanceConfig.client_network is deprecated. See google/cloud/baremetalsolution/v2/provisioning.proto;l=283
         Client network address. Filled if InstanceConfig.multivlan_config is false.
        .google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress client_network = 6 [deprecated = true];
        Specified by:
        hasClientNetwork in interface InstanceConfigOrBuilder
        Returns:
        Whether the clientNetwork field is set.

      • getClientNetwork

        @Deprecated
public InstanceConfig.NetworkAddress getClientNetwork()
        Deprecated.
        google.cloud.baremetalsolution.v2.InstanceConfig.client_network is deprecated. See google/cloud/baremetalsolution/v2/provisioning.proto;l=283
         Client network address. Filled if InstanceConfig.multivlan_config is false.
        .google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress client_network = 6 [deprecated = true];
        Specified by:
        getClientNetwork in interface InstanceConfigOrBuilder
        Returns:
        The clientNetwork.

      • hasPrivateNetwork

        @Deprecated
public boolean hasPrivateNetwork()
        Deprecated.
        google.cloud.baremetalsolution.v2.InstanceConfig.private_network is deprecated. See google/cloud/baremetalsolution/v2/provisioning.proto;l=287
         Private network address, if any. Filled if InstanceConfig.multivlan_config
 is false.
        .google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress private_network = 7 [deprecated = true];
        Specified by:
        hasPrivateNetwork in interface InstanceConfigOrBuilder
        Returns:
        Whether the privateNetwork field is set.

      • getPrivateNetwork

        @Deprecated
public InstanceConfig.NetworkAddress getPrivateNetwork()
        Deprecated.
        google.cloud.baremetalsolution.v2.InstanceConfig.private_network is deprecated. See google/cloud/baremetalsolution/v2/provisioning.proto;l=287
         Private network address, if any. Filled if InstanceConfig.multivlan_config
 is false.
        .google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress private_network = 7 [deprecated = true];
        Specified by:
        getPrivateNetwork in interface InstanceConfigOrBuilder
        Returns:
        The privateNetwork.

      • getUserNote

        public String getUserNote()
         User note field, it can be used by customers to add additional information
 for the BMS Ops team .
        string user_note = 8;
        Specified by:
        getUserNote in interface InstanceConfigOrBuilder
        Returns:
        The userNote.

      • getUserNoteBytes

        public com.google.protobuf.ByteString getUserNoteBytes()
         User note field, it can be used by customers to add additional information
 for the BMS Ops team .
        string user_note = 8;
        Specified by:
        getUserNoteBytes in interface InstanceConfigOrBuilder
        Returns:
        The bytes for userNote.

      • getAccountNetworksEnabled

        public boolean getAccountNetworksEnabled()
         If true networks can be from different projects of the same vendor account.
        bool account_networks_enabled = 9;
        Specified by:
        getAccountNetworksEnabled in interface InstanceConfigOrBuilder
        Returns:
        The accountNetworksEnabled.

      • getNetworkConfigValue

        public int getNetworkConfigValue()
         The type of network configuration on the instance.
        .google.cloud.baremetalsolution.v2.InstanceConfig.NetworkConfig network_config = 10;
        Specified by:
        getNetworkConfigValue in interface InstanceConfigOrBuilder
        Returns:
        The enum numeric value on the wire for networkConfig.

      • getNetworkTemplate

        public String getNetworkTemplate()
         Server network template name. Filled if InstanceConfig.multivlan_config is
 true.
        string network_template = 11;
        Specified by:
        getNetworkTemplate in interface InstanceConfigOrBuilder
        Returns:
        The networkTemplate.

      • getNetworkTemplateBytes

        public com.google.protobuf.ByteString getNetworkTemplateBytes()
         Server network template name. Filled if InstanceConfig.multivlan_config is
 true.
        string network_template = 11;
        Specified by:
        getNetworkTemplateBytes in interface InstanceConfigOrBuilder
        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. Filled if InstanceConfig.multivlan_config is true.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 12;
        Specified by:
        getLogicalInterfacesList in interface InstanceConfigOrBuilder

      • 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. Filled if InstanceConfig.multivlan_config is true.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 12;
        Specified by:
        getLogicalInterfacesOrBuilderList in interface InstanceConfigOrBuilder

      • 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. Filled if InstanceConfig.multivlan_config is true.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 12;
        Specified by:
        getLogicalInterfacesCount in interface InstanceConfigOrBuilder

      • 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. Filled if InstanceConfig.multivlan_config is true.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 12;
        Specified by:
        getLogicalInterfaces in interface InstanceConfigOrBuilder

      • 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. Filled if InstanceConfig.multivlan_config is true.
        repeated .google.cloud.baremetalsolution.v2.LogicalInterface logical_interfaces = 12;
        Specified by:
        getLogicalInterfacesOrBuilder in interface InstanceConfigOrBuilder

      • getSshKeyNamesList

        public com.google.protobuf.ProtocolStringList getSshKeyNamesList()
         List of names of ssh keys used to provision the instance.
        repeated string ssh_key_names = 13;
        Specified by:
        getSshKeyNamesList in interface InstanceConfigOrBuilder
        Returns:
        A list containing the sshKeyNames.

      • getSshKeyNamesCount

        public int getSshKeyNamesCount()
         List of names of ssh keys used to provision the instance.
        repeated string ssh_key_names = 13;
        Specified by:
        getSshKeyNamesCount in interface InstanceConfigOrBuilder
        Returns:
        The count of sshKeyNames.

      • getSshKeyNames

        public String getSshKeyNames​(int index)
         List of names of ssh keys used to provision the instance.
        repeated string ssh_key_names = 13;
        Specified by:
        getSshKeyNames in interface InstanceConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The sshKeyNames at the given index.

      • getSshKeyNamesBytes

        public com.google.protobuf.ByteString getSshKeyNamesBytes​(int index)
         List of names of ssh keys used to provision the instance.
        repeated string ssh_key_names = 13;
        Specified by:
        getSshKeyNamesBytes in interface InstanceConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the sshKeyNames at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static InstanceConfig getDefaultInstance()

      • parser

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

      • getParserForType

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