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 Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels as key value pairs.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
boolean	getHyperthreadingEnabled() True if you enable hyperthreading for the server, otherwise false.
String	getId() An identifier for the `Instance`, generated by the backend.
com.google.protobuf.ByteString	getIdBytes() An identifier for the `Instance`, generated by the backend.
boolean	getInteractiveSerialConsoleEnabled() True if the interactive serial console feature is enabled for the instance, false otherwise.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels as key value pairs.
Map<String,String>	getLabelsMap() Labels as key value pairs.
String	getLabelsOrDefault(String key, String defaultValue) Labels as key value pairs.
String	getLabelsOrThrow(String key) Labels as key value pairs.
LogicalInterface	getLogicalInterfaces(int index) List of logical interfaces for the instance.
int	getLogicalInterfacesCount() List of logical interfaces for the instance.
List<LogicalInterface>	getLogicalInterfacesList() List of logical interfaces for the instance.
LogicalInterfaceOrBuilder	getLogicalInterfacesOrBuilder(int index) List of logical interfaces for the instance.
List<? extends LogicalInterfaceOrBuilder>	getLogicalInterfacesOrBuilderList() List of logical interfaces for the instance.
Lun	getLuns(int index) List of LUNs associated with this server.
int	getLunsCount() List of LUNs associated with this server.
List<Lun>	getLunsList() List of LUNs associated with this server.
LunOrBuilder	getLunsOrBuilder(int index) List of LUNs associated with this server.
List<? extends LunOrBuilder>	getLunsOrBuilderList() List of LUNs associated with this server.
String	getMachineType() The server type.
com.google.protobuf.ByteString	getMachineTypeBytes() The server type.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
Network	getNetworks(int index) List of networks associated with this server.
int	getNetworksCount() List of networks associated with this server.
List<Network>	getNetworksList() List of networks associated with this server.
NetworkOrBuilder	getNetworksOrBuilder(int index) List of networks associated with this server.
List<? extends NetworkOrBuilder>	getNetworksOrBuilderList() List of networks associated with this server.
String	getNetworkTemplate() Instance network template name.
com.google.protobuf.ByteString	getNetworkTemplateBytes() Instance network template name.
String	getOsImage() The OS image currently installed on the server.
com.google.protobuf.ByteString	getOsImageBytes() The OS image currently installed on the server.
String	getPod() Immutable.
com.google.protobuf.ByteString	getPodBytes() Immutable.
Instance.State	getState() The state of the server.
int	getStateValue() The state of the server.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getId

String getId()

 An identifier for the `Instance`, generated by the backend.
 

string id = 11;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 An identifier for the `Instance`, generated by the backend.
 

string id = 11;

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()

 The server type.
 [Available server
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
 

string machine_type = 4;

Returns:

The machineType.

getMachineTypeBytes

com.google.protobuf.ByteString getMachineTypeBytes()

 The server type.
 [Available server
 types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
 

string machine_type = 4;

Returns:

The bytes for machineType.

getStateValue

int getStateValue()

 The state of the server.
 

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

Returns:

The enum numeric value on the wire for state.

getState

Instance.State getState()

 The state of the server.
 

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

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

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()

 List of LUNs associated with this server.
 

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

getLuns

Lun getLuns(int index)

 List of LUNs associated with this server.
 

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

getLunsCount

int getLunsCount()

 List of LUNs associated with this server.
 

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

getLunsOrBuilderList

List<? extends LunOrBuilder> getLunsOrBuilderList()

 List of LUNs associated with this server.
 

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

getLunsOrBuilder

LunOrBuilder getLunsOrBuilder(int index)

 List of LUNs associated with this server.
 

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

getNetworksList

List<Network> getNetworksList()

 List of networks associated with this server.
 

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

getNetworks

Network getNetworks(int index)

 List of networks associated with this server.
 

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

getNetworksCount

int getNetworksCount()

 List of networks associated with this server.
 

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

getNetworksOrBuilderList

List<? extends NetworkOrBuilder> getNetworksOrBuilderList()

 List of networks associated with this server.
 

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

getNetworksOrBuilder

NetworkOrBuilder getNetworksOrBuilder(int index)

 List of networks associated with this server.
 

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

getInteractiveSerialConsoleEnabled

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:

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;