Class StopInstanceRequest (1.56.0)

public final class StopInstanceRequest extends GeneratedMessageV3 implements StopInstanceRequestOrBuilder

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

Protobuf type google.cloud.compute.v1.StopInstanceRequest

Static Fields

DISCARD_LOCAL_SSD_FIELD_NUMBER

public static final int DISCARD_LOCAL_SSD_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_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 StopInstanceRequest getDefaultInstance()
Returns
Type Description
StopInstanceRequest

getDescriptor()

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

newBuilder()

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

newBuilder(StopInstanceRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StopInstanceRequest getDefaultInstanceForType()
Returns
Type Description
StopInstanceRequest

getDiscardLocalSsd()

public boolean getDiscardLocalSsd()

This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.

optional bool discard_local_ssd = 319517903;

Returns
Type Description
boolean

The discardLocalSsd.

getInstance()

public String getInstance()

Name of the instance resource to stop.

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

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

Name of the instance resource to stop.

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

Returns
Type Description
ByteString

The bytes for instance.

getParserForType()

public Parser<StopInstanceRequest> getParserForType()
Returns
Type Description
Parser<StopInstanceRequest>
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.

hasDiscardLocalSsd()

public boolean hasDiscardLocalSsd()

This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.

optional bool discard_local_ssd = 319517903;

Returns
Type Description
boolean

Whether the discardLocalSsd 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 StopInstanceRequest.Builder newBuilderForType()
Returns
Type Description
StopInstanceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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