Class UpdateInstanceRequest (1.57.0)

public final class UpdateInstanceRequest extends GeneratedMessageV3 implements UpdateInstanceRequestOrBuilder

A request message for Instances.Update. See the method description for details.

Protobuf type google.cloud.compute.v1.UpdateInstanceRequest

Static Fields

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_RESOURCE_FIELD_NUMBER

public static final int INSTANCE_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

MINIMAL_ACTION_FIELD_NUMBER

public static final int MINIMAL_ACTION_FIELD_NUMBER
Field Value
Type Description
int

MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER

public static final int MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateInstanceRequest getDefaultInstance()
Returns
Type Description
UpdateInstanceRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UpdateInstanceRequest.Builder newBuilder()
Returns
Type Description
UpdateInstanceRequest.Builder

newBuilder(UpdateInstanceRequest prototype)

public static UpdateInstanceRequest.Builder newBuilder(UpdateInstanceRequest prototype)
Parameter
Name Description
prototype UpdateInstanceRequest
Returns
Type Description
UpdateInstanceRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateInstanceRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateInstanceRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateInstanceRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateInstanceRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateInstanceRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateInstanceRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateInstanceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateInstanceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateInstanceRequest> parser()
Returns
Type Description
Parser<UpdateInstanceRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateInstanceRequest getDefaultInstanceForType()
Returns
Type Description
UpdateInstanceRequest

getInstance()

public String getInstance()

Name of the instance resource to update.

string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

Name of the instance resource to update.

string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for instance.

getInstanceResource()

public Instance getInstanceResource()

The body resource for this request

.google.cloud.compute.v1.Instance instance_resource = 215988344 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Instance

The instanceResource.

getInstanceResourceOrBuilder()

public InstanceOrBuilder getInstanceResourceOrBuilder()

The body resource for this request

.google.cloud.compute.v1.Instance instance_resource = 215988344 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InstanceOrBuilder

getMinimalAction()

public String getMinimalAction()

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.

optional string minimal_action = 270567060;

Returns
Type Description
String

The minimalAction.

getMinimalActionBytes()

public ByteString getMinimalActionBytes()

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.

optional string minimal_action = 270567060;

Returns
Type Description
ByteString

The bytes for minimalAction.

getMostDisruptiveAllowedAction()

public String getMostDisruptiveAllowedAction()

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.

optional string most_disruptive_allowed_action = 66103053;

Returns
Type Description
String

The mostDisruptiveAllowedAction.

getMostDisruptiveAllowedActionBytes()

public ByteString getMostDisruptiveAllowedActionBytes()

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.

optional string most_disruptive_allowed_action = 66103053;

Returns
Type Description
ByteString

The bytes for mostDisruptiveAllowedAction.

getParserForType()

public Parser<UpdateInstanceRequest> getParserForType()
Returns
Type Description
Parser<UpdateInstanceRequest>
Overrides

getProject()

public String getProject()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Returns
Type Description
ByteString

The bytes for project.

getRequestId()

public String getRequestId()

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

optional string request_id = 37109963;

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

optional string request_id = 37109963;

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getZone()

public String getZone()

The name of the zone for this request.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "zone"];

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

The name of the zone for this request.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "zone"];

Returns
Type Description
ByteString

The bytes for zone.

hasInstanceResource()

public boolean hasInstanceResource()

The body resource for this request

.google.cloud.compute.v1.Instance instance_resource = 215988344 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the instanceResource field is set.

hasMinimalAction()

public boolean hasMinimalAction()

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.

optional string minimal_action = 270567060;

Returns
Type Description
boolean

Whether the minimalAction field is set.

hasMostDisruptiveAllowedAction()

public boolean hasMostDisruptiveAllowedAction()

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.

optional string most_disruptive_allowed_action = 66103053;

Returns
Type Description
boolean

Whether the mostDisruptiveAllowedAction field is set.

hasRequestId()

public boolean hasRequestId()

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

optional string request_id = 37109963;

Returns
Type Description
boolean

Whether the requestId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateInstanceRequest.Builder newBuilderForType()
Returns
Type Description
UpdateInstanceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateInstanceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateInstanceRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateInstanceRequest.Builder toBuilder()
Returns
Type Description
UpdateInstanceRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException