Class ManagedInstance (1.42.0)

public final class ManagedInstance extends GeneratedMessageV3 implements ManagedInstanceOrBuilder

A Managed Instance resource.

Protobuf type google.cloud.compute.v1.ManagedInstance

Static Fields

CURRENT_ACTION_FIELD_NUMBER

public static final int CURRENT_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_HEALTH_FIELD_NUMBER

public static final int INSTANCE_HEALTH_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_STATUS_FIELD_NUMBER

public static final int INSTANCE_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

LAST_ATTEMPT_FIELD_NUMBER

public static final int LAST_ATTEMPT_FIELD_NUMBER
Field Value
TypeDescription
int

PRESERVED_STATE_FROM_CONFIG_FIELD_NUMBER

public static final int PRESERVED_STATE_FROM_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PRESERVED_STATE_FROM_POLICY_FIELD_NUMBER

public static final int PRESERVED_STATE_FROM_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ManagedInstance getDefaultInstance()
Returns
TypeDescription
ManagedInstance

getDescriptor()

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

newBuilder()

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

newBuilder(ManagedInstance prototype)

public static ManagedInstance.Builder newBuilder(ManagedInstance prototype)
Parameter
NameDescription
prototypeManagedInstance
Returns
TypeDescription
ManagedInstance.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCurrentAction()

public String getCurrentAction()

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Check the CurrentAction enum for the list of possible values.

optional string current_action = 178475964;

Returns
TypeDescription
String

The currentAction.

getCurrentActionBytes()

public ByteString getCurrentActionBytes()

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Check the CurrentAction enum for the list of possible values.

optional string current_action = 178475964;

Returns
TypeDescription
ByteString

The bytes for currentAction.

getDefaultInstanceForType()

public ManagedInstance getDefaultInstanceForType()
Returns
TypeDescription
ManagedInstance

getId()

public long getId()

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getInstance()

public String getInstance()

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

optional string instance = 18257045;

Returns
TypeDescription
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

optional string instance = 18257045;

Returns
TypeDescription
ByteString

The bytes for instance.

getInstanceHealth(int index)

public ManagedInstanceInstanceHealth getInstanceHealth(int index)

[Output Only] Health state of the instance per health-check.

repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Parameter
NameDescription
indexint
Returns
TypeDescription
ManagedInstanceInstanceHealth

getInstanceHealthCount()

public int getInstanceHealthCount()

[Output Only] Health state of the instance per health-check.

repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Returns
TypeDescription
int

getInstanceHealthList()

public List<ManagedInstanceInstanceHealth> getInstanceHealthList()

[Output Only] Health state of the instance per health-check.

repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Returns
TypeDescription
List<ManagedInstanceInstanceHealth>

getInstanceHealthOrBuilder(int index)

public ManagedInstanceInstanceHealthOrBuilder getInstanceHealthOrBuilder(int index)

[Output Only] Health state of the instance per health-check.

repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Parameter
NameDescription
indexint
Returns
TypeDescription
ManagedInstanceInstanceHealthOrBuilder

getInstanceHealthOrBuilderList()

public List<? extends ManagedInstanceInstanceHealthOrBuilder> getInstanceHealthOrBuilderList()

[Output Only] Health state of the instance per health-check.

repeated .google.cloud.compute.v1.ManagedInstanceInstanceHealth instance_health = 382667078;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.ManagedInstanceInstanceHealthOrBuilder>

getInstanceStatus()

public String getInstanceStatus()

[Output Only] The status of the instance. This field is empty when the instance does not exist. Check the InstanceStatus enum for the list of possible values.

optional string instance_status = 174577372;

Returns
TypeDescription
String

The instanceStatus.

getInstanceStatusBytes()

public ByteString getInstanceStatusBytes()

[Output Only] The status of the instance. This field is empty when the instance does not exist. Check the InstanceStatus enum for the list of possible values.

optional string instance_status = 174577372;

Returns
TypeDescription
ByteString

The bytes for instanceStatus.

getLastAttempt()

public ManagedInstanceLastAttempt getLastAttempt()

[Output Only] Information about the last attempt to create or delete the instance.

optional .google.cloud.compute.v1.ManagedInstanceLastAttempt last_attempt = 434771492;

Returns
TypeDescription
ManagedInstanceLastAttempt

The lastAttempt.

getLastAttemptOrBuilder()

public ManagedInstanceLastAttemptOrBuilder getLastAttemptOrBuilder()

[Output Only] Information about the last attempt to create or delete the instance.

optional .google.cloud.compute.v1.ManagedInstanceLastAttempt last_attempt = 434771492;

Returns
TypeDescription
ManagedInstanceLastAttemptOrBuilder

getParserForType()

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

getPreservedStateFromConfig()

public PreservedState getPreservedStateFromConfig()

[Output Only] Preserved state applied from per-instance config for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_config = 98661858;

Returns
TypeDescription
PreservedState

The preservedStateFromConfig.

getPreservedStateFromConfigOrBuilder()

public PreservedStateOrBuilder getPreservedStateFromConfigOrBuilder()

[Output Only] Preserved state applied from per-instance config for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_config = 98661858;

Returns
TypeDescription
PreservedStateOrBuilder

getPreservedStateFromPolicy()

public PreservedState getPreservedStateFromPolicy()

[Output Only] Preserved state generated based on stateful policy for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954;

Returns
TypeDescription
PreservedState

The preservedStateFromPolicy.

getPreservedStateFromPolicyOrBuilder()

public PreservedStateOrBuilder getPreservedStateFromPolicyOrBuilder()

[Output Only] Preserved state generated based on stateful policy for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954;

Returns
TypeDescription
PreservedStateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVersion()

public ManagedInstanceVersion getVersion()

[Output Only] Intended version of this instance.

optional .google.cloud.compute.v1.ManagedInstanceVersion version = 351608024;

Returns
TypeDescription
ManagedInstanceVersion

The version.

getVersionOrBuilder()

public ManagedInstanceVersionOrBuilder getVersionOrBuilder()

[Output Only] Intended version of this instance.

optional .google.cloud.compute.v1.ManagedInstanceVersion version = 351608024;

Returns
TypeDescription
ManagedInstanceVersionOrBuilder

hasCurrentAction()

public boolean hasCurrentAction()

[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. Check the CurrentAction enum for the list of possible values.

optional string current_action = 178475964;

Returns
TypeDescription
boolean

Whether the currentAction field is set.

hasId()

public boolean hasId()

[Output only] The unique identifier for this resource. This field is empty when instance does not exist.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasInstance()

public boolean hasInstance()

[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.

optional string instance = 18257045;

Returns
TypeDescription
boolean

Whether the instance field is set.

hasInstanceStatus()

public boolean hasInstanceStatus()

[Output Only] The status of the instance. This field is empty when the instance does not exist. Check the InstanceStatus enum for the list of possible values.

optional string instance_status = 174577372;

Returns
TypeDescription
boolean

Whether the instanceStatus field is set.

hasLastAttempt()

public boolean hasLastAttempt()

[Output Only] Information about the last attempt to create or delete the instance.

optional .google.cloud.compute.v1.ManagedInstanceLastAttempt last_attempt = 434771492;

Returns
TypeDescription
boolean

Whether the lastAttempt field is set.

hasPreservedStateFromConfig()

public boolean hasPreservedStateFromConfig()

[Output Only] Preserved state applied from per-instance config for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_config = 98661858;

Returns
TypeDescription
boolean

Whether the preservedStateFromConfig field is set.

hasPreservedStateFromPolicy()

public boolean hasPreservedStateFromPolicy()

[Output Only] Preserved state generated based on stateful policy for this instance.

optional .google.cloud.compute.v1.PreservedState preserved_state_from_policy = 470783954;

Returns
TypeDescription
boolean

Whether the preservedStateFromPolicy field is set.

hasVersion()

public boolean hasVersion()

[Output Only] Intended version of this instance.

optional .google.cloud.compute.v1.ManagedInstanceVersion version = 351608024;

Returns
TypeDescription
boolean

Whether the version field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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