Class: Google::Cloud::BareMetalSolution::V2::InstanceConfig

Inherits:

Object

Object
Google::Cloud::BareMetalSolution::V2::InstanceConfig

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb

Overview

Configuration parameters for a new instance.

Defined Under Namespace

Modules: NetworkConfig Classes: NetworkAddress

Instance Attribute Summary collapse

#account_networks_enabled ⇒ ::Boolean
If true networks can be from different projects of the same vendor account.
#client_network ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#hyperthreading ⇒ ::Boolean
Whether the instance should be provisioned with Hyperthreading enabled.
#id ⇒ ::String
A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
#instance_type ⇒ ::String
Instance type.
#logical_interfaces ⇒ ::Array<::Google::Cloud::BareMetalSolution::V2::LogicalInterface>
List of logical interfaces for the instance.
#name ⇒ ::String readonly
Output only.
#network_config ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkConfig
The type of network configuration on the instance.
#network_template ⇒ ::String
Server network template name.
#os_image ⇒ ::String
OS image to initialize the instance.
#private_network ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#ssh_key_names ⇒ ::Array<::String>
List of names of ssh keys used to provision the instance.
#user_note ⇒ ::String
User note field, it can be used by customers to add additional information for the BMS Ops team .

Instance Attribute Details

#account_networks_enabled ⇒ `::Boolean`

Returns If true networks can be from different projects of the same vendor account.

Returns:

(::Boolean) —
If true networks can be from different projects of the same vendor account.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#client_network ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Client network address. Filled if InstanceConfig.multivlan_config is false.

Returns:

(::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress) —
Client network address. Filled if InstanceConfig.multivlan_config is false.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#hyperthreading ⇒ `::Boolean`

Returns Whether the instance should be provisioned with Hyperthreading enabled.

Returns:

(::Boolean) —
Whether the instance should be provisioned with Hyperthreading enabled.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#id ⇒ `::String`

Returns A transient unique identifier to idenfity an instance within an ProvisioningConfig request.

Returns:

(::String) —
A transient unique identifier to idenfity an instance within an ProvisioningConfig request.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#instance_type ⇒ `::String`

Returns Instance type. Available types.

Returns:

(::String) —
Instance type. Available types

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#logical_interfaces ⇒ `::Array<::Google::Cloud::BareMetalSolution::V2::LogicalInterface>`

Returns 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.

Returns:

(::Array<::Google::Cloud::BareMetalSolution::V2::LogicalInterface>) —
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.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#name ⇒ `::String` (readonly)

Returns Output only. The name of the instance config.

Returns:

(::String) —
Output only. The name of the instance config.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#network_config ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkConfig`

Returns The type of network configuration on the instance.

Returns:

(::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkConfig) —
The type of network configuration on the instance.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#network_template ⇒ `::String`

Returns Server network template name. Filled if InstanceConfig.multivlan_config is true.

Returns:

(::String) —
Server network template name. Filled if InstanceConfig.multivlan_config is true.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#os_image ⇒ `::String`

Returns OS image to initialize the instance. Available images.

Returns:

(::String) —
OS image to initialize the instance. Available images

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#private_network ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Private network address, if any. Filled if InstanceConfig.multivlan_config is false.

Returns:

(::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress) —
Private network address, if any. Filled if InstanceConfig.multivlan_config is false.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#ssh_key_names ⇒ `::Array<::String>`

Returns List of names of ssh keys used to provision the instance.

Returns:

(::Array<::String>) —
List of names of ssh keys used to provision the instance.

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

#user_note ⇒ `::String`

Returns User note field, it can be used by customers to add additional information for the BMS Ops team .

Returns:

(::String) —
User note field, it can be used by customers to add additional information for the BMS Ops team .

# File 'proto_docs/google/cloud/baremetalsolution/v2/provisioning.rb', line 264

class InstanceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A network.
  # @!attribute [rw] network_id
  #   @return [::String]
  #     Id of the network to use, within the same ProvisioningConfig request.
  # @!attribute [rw] address
  #   @return [::String]
  #     IPv4 address to be assigned to the server.
  # @!attribute [rw] existing_network_id
  #   @return [::String]
  #     Name of the existing network to use.
  class NetworkAddress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The network configuration of the instance.
  module NetworkConfig
    # The unspecified network configuration.
    NETWORKCONFIG_UNSPECIFIED = 0

    # Instance part of single client network and single private network.
    SINGLE_VLAN = 1

    # Instance part of multiple (or single) client networks and private
    # networks.
    MULTI_VLAN = 2
  end
end

Class: Google::Cloud::BareMetalSolution::V2::InstanceConfig

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#account_networks_enabled ⇒ ::Boolean

#client_network ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress

#hyperthreading ⇒ ::Boolean

#id ⇒ ::String

#instance_type ⇒ ::String

#logical_interfaces ⇒ ::Array<::Google::Cloud::BareMetalSolution::V2::LogicalInterface>

#name ⇒ ::String (readonly)

#network_config ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkConfig

#network_template ⇒ ::String

#os_image ⇒ ::String

#private_network ⇒ ::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress

#ssh_key_names ⇒ ::Array<::String>

#user_note ⇒ ::String

#account_networks_enabled ⇒ `::Boolean`

#client_network ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress`

#hyperthreading ⇒ `::Boolean`

#id ⇒ `::String`

#instance_type ⇒ `::String`

#logical_interfaces ⇒ `::Array<::Google::Cloud::BareMetalSolution::V2::LogicalInterface>`

#name ⇒ `::String` (readonly)

#network_config ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkConfig`

#network_template ⇒ `::String`

#os_image ⇒ `::String`

#private_network ⇒ `::Google::Cloud::BareMetalSolution::V2::InstanceConfig::NetworkAddress`

#ssh_key_names ⇒ `::Array<::String>`

#user_note ⇒ `::String`