Class InstanceConfig (0.31.0)

public final class InstanceConfig extends GeneratedMessageV3 implements InstanceConfigOrBuilder

Configuration parameters for a new instance.

Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig

Static Fields

ACCOUNT_NETWORKS_ENABLED_FIELD_NUMBER

public static final int ACCOUNT_NETWORKS_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

CLIENT_NETWORK_FIELD_NUMBER

public static final int CLIENT_NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

HYPERTHREADING_FIELD_NUMBER

public static final int HYPERTHREADING_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_TYPE_FIELD_NUMBER

public static final int INSTANCE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

LOGICAL_INTERFACES_FIELD_NUMBER

public static final int LOGICAL_INTERFACES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_TEMPLATE_FIELD_NUMBER

public static final int NETWORK_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

OS_IMAGE_FIELD_NUMBER

public static final int OS_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_NETWORK_FIELD_NUMBER

public static final int PRIVATE_NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

SSH_KEY_NAMES_FIELD_NUMBER

public static final int SSH_KEY_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

USER_NOTE_FIELD_NUMBER

public static final int USER_NOTE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InstanceConfig getDefaultInstance()
Returns
TypeDescription
InstanceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InstanceConfig.Builder newBuilder()
Returns
TypeDescription
InstanceConfig.Builder

newBuilder(InstanceConfig prototype)

public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)
Parameter
NameDescription
prototypeInstanceConfig
Returns
TypeDescription
InstanceConfig.Builder

parseDelimitedFrom(InputStream input)

public static InstanceConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstanceConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstanceConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstanceConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstanceConfig> parser()
Returns
TypeDescription
Parser<InstanceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccountNetworksEnabled()

public boolean getAccountNetworksEnabled()

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

bool account_networks_enabled = 9;

Returns
TypeDescription
boolean

The accountNetworksEnabled.

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

Returns
TypeDescription
InstanceConfig.NetworkAddress

The clientNetwork.

getClientNetworkOrBuilder() (deprecated)

public InstanceConfig.NetworkAddressOrBuilder getClientNetworkOrBuilder()

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

.google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress client_network = 6 [deprecated = true];

Returns
TypeDescription
InstanceConfig.NetworkAddressOrBuilder

getDefaultInstanceForType()

public InstanceConfig getDefaultInstanceForType()
Returns
TypeDescription
InstanceConfig

getHyperthreading()

public boolean getHyperthreading()

Whether the instance should be provisioned with Hyperthreading enabled.

bool hyperthreading = 4;

Returns
TypeDescription
boolean

The hyperthreading.

getId()

public String getId()

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

string id = 2;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

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

string id = 2;

Returns
TypeDescription
ByteString

The bytes for id.

getInstanceType()

public String getInstanceType()

Instance type. Available types

string instance_type = 3;

Returns
TypeDescription
String

The instanceType.

getInstanceTypeBytes()

public ByteString getInstanceTypeBytes()

Instance type. Available types

string instance_type = 3;

Returns
TypeDescription
ByteString

The bytes for instanceType.

getLogicalInterfaces(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogicalInterface

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<LogicalInterface>

getLogicalInterfacesOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
LogicalInterfaceOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.cloud.baremetalsolution.v2.LogicalInterfaceOrBuilder>

getName()

public String getName()

Output only. The name of the instance config.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the instance config.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getNetworkConfig()

public InstanceConfig.NetworkConfig getNetworkConfig()

The type of network configuration on the instance.

.google.cloud.baremetalsolution.v2.InstanceConfig.NetworkConfig network_config = 10;

Returns
TypeDescription
InstanceConfig.NetworkConfig

The networkConfig.

getNetworkConfigValue()

public int getNetworkConfigValue()

The type of network configuration on the instance.

.google.cloud.baremetalsolution.v2.InstanceConfig.NetworkConfig network_config = 10;

Returns
TypeDescription
int

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;

Returns
TypeDescription
String

The networkTemplate.

getNetworkTemplateBytes()

public ByteString getNetworkTemplateBytes()

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

string network_template = 11;

Returns
TypeDescription
ByteString

The bytes for networkTemplate.

getOsImage()

public String getOsImage()

OS image to initialize the instance. Available images

string os_image = 5;

Returns
TypeDescription
String

The osImage.

getOsImageBytes()

public ByteString getOsImageBytes()

OS image to initialize the instance. Available images

string os_image = 5;

Returns
TypeDescription
ByteString

The bytes for osImage.

getParserForType()

public Parser<InstanceConfig> getParserForType()
Returns
TypeDescription
Parser<InstanceConfig>
Overrides

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

Returns
TypeDescription
InstanceConfig.NetworkAddress

The privateNetwork.

getPrivateNetworkOrBuilder() (deprecated)

public InstanceConfig.NetworkAddressOrBuilder getPrivateNetworkOrBuilder()

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

.google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress private_network = 7 [deprecated = true];

Returns
TypeDescription
InstanceConfig.NetworkAddressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSshKeyNames(int index)

public String getSshKeyNames(int index)

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

repeated string ssh_key_names = 13;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sshKeyNames at the given index.

getSshKeyNamesBytes(int index)

public ByteString getSshKeyNamesBytes(int index)

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

repeated string ssh_key_names = 13;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sshKeyNames at the given index.

getSshKeyNamesCount()

public int getSshKeyNamesCount()

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

repeated string ssh_key_names = 13;

Returns
TypeDescription
int

The count of sshKeyNames.

getSshKeyNamesList()

public ProtocolStringList getSshKeyNamesList()

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

repeated string ssh_key_names = 13;

Returns
TypeDescription
ProtocolStringList

A list containing the sshKeyNames.

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;

Returns
TypeDescription
String

The userNote.

getUserNoteBytes()

public ByteString getUserNoteBytes()

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

string user_note = 8;

Returns
TypeDescription
ByteString

The bytes for userNote.

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

Returns
TypeDescription
boolean

Whether the clientNetwork field is set.

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

Returns
TypeDescription
boolean

Whether the privateNetwork field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InstanceConfig.Builder newBuilderForType()
Returns
TypeDescription
InstanceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstanceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InstanceConfig.Builder toBuilder()
Returns
TypeDescription
InstanceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException