Class CancelRolloutRequest.Builder (1.105.0) 

public static final class CancelRolloutRequest.Builder extends GeneratedMessage.Builder<CancelRolloutRequest.Builder> implements CancelRolloutRequestOrBuilder

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

Protobuf type google.cloud.compute.v1.CancelRolloutRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CancelRolloutRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public CancelRolloutRequest build()
Returns
Type Description
CancelRolloutRequest

buildPartial()

public CancelRolloutRequest buildPartial()
Returns
Type Description
CancelRolloutRequest

clear()

public CancelRolloutRequest.Builder clear()
Returns
Type Description
CancelRolloutRequest.Builder
Overrides

clearProject()

public CancelRolloutRequest.Builder clearProject()

Project ID for this request.

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

Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

clearRequestId()

public CancelRolloutRequest.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
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

clearRollback()

public CancelRolloutRequest.Builder clearRollback()

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

This builder for chaining.

clearRollout()

public CancelRolloutRequest.Builder clearRollout()

Name of the Rollout resource to cancel.

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

Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public CancelRolloutRequest getDefaultInstanceForType()
Returns
Type Description
CancelRolloutRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CancelRolloutRequest other)

public CancelRolloutRequest.Builder mergeFrom(CancelRolloutRequest other)
Parameter
Name Description
other CancelRolloutRequest
Returns
Type Description
CancelRolloutRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CancelRolloutRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelRolloutRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CancelRolloutRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CancelRolloutRequest.Builder
Overrides

setProject(String value)

public CancelRolloutRequest.Builder setProject(String value)

Project ID for this request.

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

Parameter
Name Description
value String

The project to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public CancelRolloutRequest.Builder setProjectBytes(ByteString value)

Project ID for this request.

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

Parameter
Name Description
value ByteString

The bytes for project to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setRequestId(String value)

public CancelRolloutRequest.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
Name Description
value String

The requestId to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CancelRolloutRequest.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
Name Description
value ByteString

The bytes for requestId to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setRollback(boolean value)

public CancelRolloutRequest.Builder setRollback(boolean value)

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;

Parameter
Name Description
value boolean

The rollback to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setRollout(String value)

public CancelRolloutRequest.Builder setRollout(String value)

Name of the Rollout resource to cancel.

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

Parameter
Name Description
value String

The rollout to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.

setRolloutBytes(ByteString value)

public CancelRolloutRequest.Builder setRolloutBytes(ByteString value)

Name of the Rollout resource to cancel.

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

Parameter
Name Description
value ByteString

The bytes for rollout to set.
Returns
Type Description
CancelRolloutRequest.Builder

This builder for chaining.