com.google.cloud.baremetalsolution.v2.InstanceOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-bare-metal-solution-v2 Show documentation
Show all versions of proto-google-cloud-bare-metal-solution-v2 Show documentation
Proto library for google-cloud-bare-metal-solution
/*
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/baremetalsolution/v2/instance.proto
package com.google.cloud.baremetalsolution.v2;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.baremetalsolution.v2.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. An identifier for the `Instance`, generated by the backend.
*
*
* string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The id.
*/
java.lang.String getId();
/**
*
*
*
* Output only. An identifier for the `Instance`, generated by the backend.
*
*
* string id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for id.
*/
com.google.protobuf.ByteString getIdBytes();
/**
*
*
*
* Output only. Create a time stamp.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Create a time stamp.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Create a time stamp.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Update a time stamp.
*
*
* .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Update a time stamp.
*
*
* .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Update a time stamp.
*
*
* .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Immutable. The server type.
* [Available server
* types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
*
*
* string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The machineType.
*/
java.lang.String getMachineType();
/**
*
*
*
* Immutable. The server type.
* [Available server
* types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
*
*
* string machine_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The bytes for machineType.
*/
com.google.protobuf.ByteString getMachineTypeBytes();
/**
*
*
*
* Output only. The state of the server.
*
*
*
* .google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The state of the server.
*
*
*
* .google.cloud.baremetalsolution.v2.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.baremetalsolution.v2.Instance.State getState();
/**
*
*
*
* True if you enable hyperthreading for the server, otherwise false.
* The default value is false.
*
*
* bool hyperthreading_enabled = 6;
*
* @return The hyperthreadingEnabled.
*/
boolean getHyperthreadingEnabled();
/**
*
*
*
* Labels as key value pairs.
*
*
* map<string, string> labels = 7;
*/
int getLabelsCount();
/**
*
*
*
* Labels as key value pairs.
*
*
* map<string, string> labels = 7;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels as key value pairs.
*
*
* map<string, string> labels = 7;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels as key value pairs.
*
*
* map<string, string> labels = 7;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels as key value pairs.
*
*
* map<string, string> labels = 7;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Immutable. List of LUNs associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
java.util.List getLunsList();
/**
*
*
*
* Immutable. List of LUNs associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
com.google.cloud.baremetalsolution.v2.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];
*
*/
int getLunsCount();
/**
*
*
*
* Immutable. List of LUNs associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
java.util.List
getLunsOrBuilderList();
/**
*
*
*
* Immutable. List of LUNs associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Lun luns = 8 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
com.google.cloud.baremetalsolution.v2.LunOrBuilder getLunsOrBuilder(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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.baremetalsolution.v2.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.baremetalsolution.v2.VolumeOrBuilder getVolumesOrBuilder(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];
*
*/
java.util.List getNetworksList();
/**
*
*
*
* Output only. List of networks associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.baremetalsolution.v2.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];
*
*/
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];
*
*/
java.util.List
getNetworksOrBuilderList();
/**
*
*
*
* Output only. List of networks associated with this server.
*
*
*
* repeated .google.cloud.baremetalsolution.v2.Network networks = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.baremetalsolution.v2.NetworkOrBuilder getNetworksOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return The interactiveSerialConsoleEnabled.
*/
boolean getInteractiveSerialConsoleEnabled();
/**
*
*
*
* The OS image currently installed on the server.
*
*
* string os_image = 12;
*
* @return The osImage.
*/
java.lang.String getOsImage();
/**
*
*
*
* The OS image currently installed on the server.
*
*
* string os_image = 12;
*
* @return The bytes for osImage.
*/
com.google.protobuf.ByteString getOsImageBytes();
/**
*
*
*
* 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];
*
* @return The pod.
*/
java.lang.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];
*
* @return The bytes for pod.
*/
com.google.protobuf.ByteString getPodBytes();
/**
*
*
*
* 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) = { ... }
*
* @return The networkTemplate.
*/
java.lang.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) = { ... }
*
* @return The bytes for networkTemplate.
*/
com.google.protobuf.ByteString getNetworkTemplateBytes();
/**
*
*
*
* 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;
*
*/
java.util.List 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;
*
*/
com.google.cloud.baremetalsolution.v2.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.baremetalsolution.v2.LogicalInterfaceOrBuilder getLogicalInterfacesOrBuilder(
int index);
/**
*
*
*
* Output only. Text field about info for logging in.
*
*
* string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The loginInfo.
*/
java.lang.String getLoginInfo();
/**
*
*
*
* Output only. Text field about info for logging in.
*
*
* string login_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for loginInfo.
*/
com.google.protobuf.ByteString getLoginInfoBytes();
/**
*
*
*
* The workload profile for the instance.
*
*
* .google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
*
* @return The enum numeric value on the wire for workloadProfile.
*/
int getWorkloadProfileValue();
/**
*
*
*
* The workload profile for the instance.
*
*
* .google.cloud.baremetalsolution.v2.WorkloadProfile workload_profile = 18;
*
* @return The workloadProfile.
*/
com.google.cloud.baremetalsolution.v2.WorkloadProfile getWorkloadProfile();
/**
*
*
*
* Output only. The firmware version for the instance.
*
*
* string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The firmwareVersion.
*/
java.lang.String getFirmwareVersion();
/**
*
*
*
* Output only. The firmware version for the instance.
*
*
* string firmware_version = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for firmwareVersion.
*/
com.google.protobuf.ByteString getFirmwareVersionBytes();
}