Class Instance (0.7.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

A server.

Protobuf type google.cloud.baremetalsolution.v2.Instance

Implements

InstanceOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

HYPERTHREADING_ENABLED_FIELD_NUMBER

public static final int HYPERTHREADING_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INTERACTIVE_SERIAL_CONSOLE_ENABLED_FIELD_NUMBER

public static final int INTERACTIVE_SERIAL_CONSOLE_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LOGICAL_INTERFACES_FIELD_NUMBER

public static final int LOGICAL_INTERFACES_FIELD_NUMBER
Field Value
TypeDescription
int

LUNS_FIELD_NUMBER

public static final int LUNS_FIELD_NUMBER
Field Value
TypeDescription
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORKS_FIELD_NUMBER

public static final int NETWORKS_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

POD_FIELD_NUMBER

public static final int POD_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

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

newBuilder()

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

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs.

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Create a time stamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create a time stamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getHyperthreadingEnabled()

public boolean getHyperthreadingEnabled()

True if you enable hyperthreading for the server, otherwise false. The default value is false.

bool hyperthreading_enabled = 6;

Returns
TypeDescription
boolean

The hyperthreadingEnabled.

getId()

public String getId()

An identifier for the Instance, generated by the backend.

string id = 11;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

An identifier for the Instance, generated by the backend.

string id = 11;

Returns
TypeDescription
ByteString

The bytes for id.

getInteractiveSerialConsoleEnabled()

public boolean getInteractiveSerialConsoleEnabled()

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;

Returns
TypeDescription
boolean

The interactiveSerialConsoleEnabled.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 7;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs.

map<string, string> labels = 7;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

map<string, string> labels = 7;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs.

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

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

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

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

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

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

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

getLuns(int index)

public Lun getLuns(int index)

List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
Lun

getLunsCount()

public int getLunsCount()

List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8;

Returns
TypeDescription
int

getLunsList()

public List<Lun> getLunsList()

List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8;

Returns
TypeDescription
List<Lun>

getLunsOrBuilder(int index)

public LunOrBuilder getLunsOrBuilder(int index)

List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
LunOrBuilder

getLunsOrBuilderList()

public List<? extends LunOrBuilder> getLunsOrBuilderList()

List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8;

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

getMachineType()

public String getMachineType()

The server type. Available server types

string machine_type = 4;

Returns
TypeDescription
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

The server type. Available server types

string machine_type = 4;

Returns
TypeDescription
ByteString

The bytes for machineType.

getName()

public String getName()

Output only. 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) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. 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) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

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) = { ... }

Returns
TypeDescription
String

The networkTemplate.

getNetworkTemplateBytes()

public 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
TypeDescription
ByteString

The bytes for networkTemplate.

getNetworks(int index)

public Network getNetworks(int index)

List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
Network

getNetworksCount()

public int getNetworksCount()

List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9;

Returns
TypeDescription
int

getNetworksList()

public List<Network> getNetworksList()

List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9;

Returns
TypeDescription
List<Network>

getNetworksOrBuilder(int index)

public NetworkOrBuilder getNetworksOrBuilder(int index)

List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
NetworkOrBuilder

getNetworksOrBuilderList()

public List<? extends NetworkOrBuilder> getNetworksOrBuilderList()

List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9;

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

getOsImage()

public String getOsImage()

The OS image currently installed on the server.

string os_image = 12;

Returns
TypeDescription
String

The osImage.

getOsImageBytes()

public ByteString getOsImageBytes()

The OS image currently installed on the server.

string os_image = 12;

Returns
TypeDescription
ByteString

The bytes for osImage.

getParserForType()

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

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

Returns
TypeDescription
String

The pod.

getPodBytes()

public 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
TypeDescription
ByteString

The bytes for pod.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Instance.State getState()

The state of the server.

.google.cloud.baremetalsolution.v2.Instance.State state = 5;

Returns
TypeDescription
Instance.State

The state.

getStateValue()

public int getStateValue()

The state of the server.

.google.cloud.baremetalsolution.v2.Instance.State state = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update a time stamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update a time stamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create a time stamp.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update a time stamp.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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