Class StopInstanceRequest (1.34.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
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StopInstanceRequest getDefaultInstance()
Returns
TypeDescription
StopInstanceRequest

getDescriptor()

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

newBuilder()

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

newBuilder(StopInstanceRequest prototype)

public static StopInstanceRequest.Builder newBuilder(StopInstanceRequest prototype)
Parameter
NameDescription
prototypeStopInstanceRequest
Returns
TypeDescription
StopInstanceRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StopInstanceRequest getDefaultInstanceForType()
Returns
TypeDescription
StopInstanceRequest

getDiscardLocalSsd()

public boolean getDiscardLocalSsd()

If true, discard the contents of any attached localSSD partitions. Default value is false.

optional bool discard_local_ssd = 319517903;

Returns
TypeDescription
boolean

The discardLocalSsd.

getInstance()

public String getInstance()

Name of the instance resource to stop.

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

Returns
TypeDescription
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

Name of the instance resource to stop.

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

Returns
TypeDescription
ByteString

The bytes for instance.

getParserForType()

public Parser<StopInstanceRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for zone.

hasDiscardLocalSsd()

public boolean hasDiscardLocalSsd()

If true, discard the contents of any attached localSSD partitions. Default value is false.

optional bool discard_local_ssd = 319517903;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the requestId 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 StopInstanceRequest.Builder newBuilderForType()
Returns
TypeDescription
StopInstanceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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