public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
A server.
Protobuf type google.cloud.baremetalsolution.v2.Instance
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FIRMWARE_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int HYPERTHREADING_ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INTERACTIVE_SERIAL_CONSOLE_ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LOGICAL_INTERFACES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LOGIN_INFO_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LUNS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MACHINE_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NETWORKS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NETWORK_TEMPLATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int OS_IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int POD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int VOLUMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int WORKLOAD_PROFILE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Instance getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Instance.Builder newBuilder()
public static Instance.Builder newBuilder(Instance prototype)
| Parameter |
|---|
| Name | Description |
prototype | Instance
|
public static Instance parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Instance> parser()
Methods
public boolean containsLabels(String key)
Labels as key value pairs.
map<string, string> labels = 7;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public 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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create a time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Instance getDefaultInstanceForType()
public 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.
|
public 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.
|
public 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.
|
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.
|
public ByteString getIdBytes()
Output only. An identifier for the Instance, generated by the backend.
string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public 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.
|
public Map<String,String> getLabels()
public int getLabelsCount()
Labels as key value pairs.
map<string, string> labels = 7;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getLabelsMap()
Labels as key value pairs.
map<string, string> labels = 7;
public String getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairs.
map<string, string> labels = 7;
public String getLabelsOrThrow(String key)
Labels as key value pairs.
map<string, string> labels = 7;
| Parameter |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
int | |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.baremetalsolution.v2.LogicalInterfaceOrBuilder> | |
public 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.
|
public 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.
|
public 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 | |
public 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 | |
public List<Lun> getLunsList()
Immutable. List of LUNs associated with this server.
repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
public 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
|
public 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> | |
public String getMachineType()
Immutable. The server type.
Available server
types
string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
String | The machineType.
|
public 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.
|
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.
|
public 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.
|
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 |
|---|
| Type | Description |
String | The networkTemplate.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for networkTemplate.
|
public 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
|
public 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 | |
public 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];
public 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
|
public 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> | |
public String getOsImage()
The OS image currently installed on the server.
string os_image = 12;
| Returns |
|---|
| Type | Description |
String | The osImage.
|
public ByteString getOsImageBytes()
The OS image currently installed on the server.
string os_image = 12;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for osImage.
|
public Parser<Instance> getParserForType()
Overrides
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.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for pod.
|
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Instance.State getState()
Output only. The state of the server.
.google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public 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.
|
public 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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update a time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public 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
|
public 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 | |
public 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];
public 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
|
public 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> | |
public WorkloadProfile getWorkloadProfile()
The workload profile for the instance.
.google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
public 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.
|
public 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.
|
public 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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public Instance.Builder newBuilderForType()
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Instance.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
