Class CancelRolloutRequest (1.105.0)

public final class CancelRolloutRequest extends GeneratedMessage implements CancelRolloutRequestOrBuilder

A request message for Rollouts.Cancel. See the method description for details.

Protobuf type google.cloud.compute.v1.CancelRolloutRequest

Static Fields

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

ROLLBACK_FIELD_NUMBER

public static final int ROLLBACK_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CancelRolloutRequest getDefaultInstance()
Returns
Type Description
CancelRolloutRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CancelRolloutRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CancelRolloutRequest getDefaultInstanceForType()
Returns
Type Description
CancelRolloutRequest

getParserForType()

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

getRollback()

public boolean getRollback()

Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

optional bool rollback = 277151460;

Returns
Type Description
boolean

The rollback.

getRollout()

public String getRollout()

Name of the Rollout resource to cancel.

string rollout = 303366577 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The rollout.

getRolloutBytes()

public ByteString getRolloutBytes()

Name of the Rollout resource to cancel.

string rollout = 303366577 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for rollout.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hasRollback()

public boolean hasRollback()

Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

optional bool rollback = 277151460;

Returns
Type Description
boolean

Whether the rollback field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CancelRolloutRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CancelRolloutRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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