Interface InstanceOrBuilder (0.39.0)

Version 0.39.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.8
• 0.2.1
• 0.1.1

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels as key value pairs.

map<string, string> labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create a time stamp.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create a time stamp.

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

Returns
Type	Description
TimestampOrBuilder

getFirmwareVersion()

public abstract String getFirmwareVersion()

Output only. The firmware version for the instance.

string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The firmwareVersion.

getFirmwareVersionBytes()

public abstract ByteString getFirmwareVersionBytes()

Output only. The firmware version for the instance.

string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for firmwareVersion.

getHyperthreadingEnabled()

public abstract boolean getHyperthreadingEnabled()

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

bool hyperthreading_enabled = 6;

Returns
Type	Description
boolean	The hyperthreadingEnabled.

getId()

public abstract String getId()

Output only. An identifier for the Instance, generated by the backend.

string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

Output only. An identifier for the Instance, generated by the backend.

string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for id.

getInteractiveSerialConsoleEnabled()

public abstract boolean getInteractiveSerialConsoleEnabled()

Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The interactiveSerialConsoleEnabled.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 7;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels as key value pairs.

map<string, string> labels = 7;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

map<string, string> labels = 7;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels as key value pairs.

map<string, string> labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLogicalInterfaces(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
LogicalInterface

getLogicalInterfacesCount()

public abstract 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
Type	Description
int

getLogicalInterfacesList()

public abstract 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
Type	Description
List<LogicalInterface>

getLogicalInterfacesOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
LogicalInterfaceOrBuilder

getLogicalInterfacesOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.cloud.baremetalsolution.v2.LogicalInterfaceOrBuilder>

getLoginInfo()

public abstract String getLoginInfo()

Output only. Text field about info for logging in.

string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The loginInfo.

getLoginInfoBytes()

public abstract ByteString getLoginInfoBytes()

Output only. Text field about info for logging in.

string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for loginInfo.

getLuns(int index)

public abstract Lun getLuns(int index)

Immutable. List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
index	int

Returns
Type	Description
Lun

getLunsCount()

public abstract int getLunsCount()

Immutable. List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int

getLunsList()

public abstract List<Lun> getLunsList()

Immutable. List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
List<Lun>

getLunsOrBuilder(int index)

public abstract LunOrBuilder getLunsOrBuilder(int index)

Immutable. List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
index	int

Returns
Type	Description
LunOrBuilder

getLunsOrBuilderList()

public abstract List<? extends LunOrBuilder> getLunsOrBuilderList()

Immutable. List of LUNs associated with this server.

repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];

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

getMachineType()

public abstract String getMachineType()

Immutable. The server type. Available server types

string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

Immutable. The server type. Available server types

string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for machineType.

getName()

public abstract String getName()

Immutable. 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) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. 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) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getNetworkTemplate()

public abstract 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
Type	Description
String	The networkTemplate.

getNetworkTemplateBytes()

public abstract 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
Type	Description
ByteString	The bytes for networkTemplate.

getNetworks(int index)

public abstract Network getNetworks(int index)

Output only. List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Network

getNetworksCount()

public abstract int getNetworksCount()

Output only. List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getNetworksList()

public abstract List<Network> getNetworksList()

Output only. List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Network>

getNetworksOrBuilder(int index)

public abstract NetworkOrBuilder getNetworksOrBuilder(int index)

Output only. List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkOrBuilder

getNetworksOrBuilderList()

public abstract List<? extends NetworkOrBuilder> getNetworksOrBuilderList()

Output only. List of networks associated with this server.

repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getOsImage()

public abstract String getOsImage()

The OS image currently installed on the server.

string os_image = 12;

Returns
Type	Description
String	The osImage.

getOsImageBytes()

public abstract ByteString getOsImageBytes()

The OS image currently installed on the server.

string os_image = 12;

Returns
Type	Description
ByteString	The bytes for osImage.

getPod()

public abstract 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
Type	Description
String	The pod.

getPodBytes()

public abstract 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
Type	Description
ByteString	The bytes for pod.

getState()

public abstract Instance.State getState()

Output only. The state of the server.

.google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Instance.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the server.

.google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Update a time stamp.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update a time stamp.

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

Returns
Type	Description
TimestampOrBuilder

getVolumes(int index)

public abstract Volume getVolumes(int index)

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.

repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Volume

getVolumesCount()

public abstract int getVolumesCount()

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.

repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int

getVolumesList()

public abstract List<Volume> getVolumesList()

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.

repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.

repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.

repeated .google.cloud.baremetalsolution.v2.Volume volumes = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.baremetalsolution.v2.VolumeOrBuilder>

getWorkloadProfile()

public abstract WorkloadProfile getWorkloadProfile()

The workload profile for the instance.

.google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;

Returns
Type	Description
WorkloadProfile	The workloadProfile.

getWorkloadProfileValue()

public abstract int getWorkloadProfileValue()

The workload profile for the instance.

.google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;

Returns
Type	Description
int	The enum numeric value on the wire for workloadProfile.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create a time stamp.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Update a time stamp.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.