Class StopInstanceRequest.Builder (1.47.0)

public static final class StopInstanceRequest.Builder extends GeneratedMessageV3.Builder<StopInstanceRequest.Builder> implements StopInstanceRequestOrBuilder

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

Protobuf type google.cloud.compute.v1.StopInstanceRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StopInstanceRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

build()

public StopInstanceRequest build()
Returns
TypeDescription
StopInstanceRequest

buildPartial()

public StopInstanceRequest buildPartial()
Returns
TypeDescription
StopInstanceRequest

clear()

public StopInstanceRequest.Builder clear()
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

clearDiscardLocalSsd()

public StopInstanceRequest.Builder clearDiscardLocalSsd()

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
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StopInstanceRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

clearInstance()

public StopInstanceRequest.Builder clearInstance()

Name of the instance resource to stop.

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

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StopInstanceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

clearProject()

public StopInstanceRequest.Builder clearProject()

Project ID for this request.

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

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

clearRequestId()

public StopInstanceRequest.Builder clearRequestId()

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
StopInstanceRequest.Builder

This builder for chaining.

clearZone()

public StopInstanceRequest.Builder clearZone()

The name of the zone for this request.

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

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

clone()

public StopInstanceRequest.Builder clone()
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

getDefaultInstanceForType()

public StopInstanceRequest getDefaultInstanceForType()
Returns
TypeDescription
StopInstanceRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
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.

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.

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()

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
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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StopInstanceRequest other)

public StopInstanceRequest.Builder mergeFrom(StopInstanceRequest other)
Parameter
NameDescription
otherStopInstanceRequest
Returns
TypeDescription
StopInstanceRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StopInstanceRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StopInstanceRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StopInstanceRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

setDiscardLocalSsd(boolean value)

public StopInstanceRequest.Builder setDiscardLocalSsd(boolean value)

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;

Parameter
NameDescription
valueboolean

The discardLocalSsd to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StopInstanceRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

setInstance(String value)

public StopInstanceRequest.Builder setInstance(String value)

Name of the instance resource to stop.

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

Parameter
NameDescription
valueString

The instance to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public StopInstanceRequest.Builder setInstanceBytes(ByteString value)

Name of the instance resource to stop.

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

Parameter
NameDescription
valueByteString

The bytes for instance to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setProject(String value)

public StopInstanceRequest.Builder setProject(String value)

Project ID for this request.

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

Parameter
NameDescription
valueString

The project to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public StopInstanceRequest.Builder setProjectBytes(ByteString value)

Project ID for this request.

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

Parameter
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StopInstanceRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

setRequestId(String value)

public StopInstanceRequest.Builder setRequestId(String value)

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;

Parameter
NameDescription
valueString

The requestId to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public StopInstanceRequest.Builder setRequestIdBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for requestId to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StopInstanceRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StopInstanceRequest.Builder
Overrides

setZone(String value)

public StopInstanceRequest.Builder setZone(String value)

The name of the zone for this request.

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

Parameter
NameDescription
valueString

The zone to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public StopInstanceRequest.Builder setZoneBytes(ByteString value)

The name of the zone for this request.

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

Parameter
NameDescription
valueByteString

The bytes for zone to set.

Returns
TypeDescription
StopInstanceRequest.Builder

This builder for chaining.