Class PauseRolloutRequest.Builder (1.105.0)

public static final class PauseRolloutRequest.Builder extends GeneratedMessage.Builder<PauseRolloutRequest.Builder> implements PauseRolloutRequestOrBuilder

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

Protobuf type google.cloud.compute.v1.PauseRolloutRequest

Static Methods

getDescriptor()

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

Methods

build()

public PauseRolloutRequest build()
Returns
Type Description
PauseRolloutRequest

buildPartial()

public PauseRolloutRequest buildPartial()
Returns
Type Description
PauseRolloutRequest

clear()

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

clearEtag()

public PauseRolloutRequest.Builder clearEtag()

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

clearProject()

public PauseRolloutRequest.Builder clearProject()

Required. Project ID for this request.

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

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

clearRequestId()

public PauseRolloutRequest.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
PauseRolloutRequest.Builder

This builder for chaining.

clearRollout()

public PauseRolloutRequest.Builder clearRollout()

Required. Name of the Rollout resource to pause.

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

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public PauseRolloutRequest getDefaultInstanceForType()
Returns
Type Description
PauseRolloutRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public String getEtag()

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Returns
Type Description
ByteString

The bytes for etag.

getProject()

public String getProject()

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

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

getRollout()

public String getRollout()

Required. Name of the Rollout resource to pause.

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

Returns
Type Description
String

The rollout.

getRolloutBytes()

public ByteString getRolloutBytes()

Required. Name of the Rollout resource to pause.

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

Returns
Type Description
ByteString

The bytes for rollout.

hasEtag()

public boolean hasEtag()

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Returns
Type Description
boolean

Whether the etag 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PauseRolloutRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setEtag(String value)

public PauseRolloutRequest.Builder setEtag(String value)

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public PauseRolloutRequest.Builder setEtagBytes(ByteString value)

The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

optional string etag = 3123477;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

setProject(String value)

public PauseRolloutRequest.Builder setProject(String value)

Required. 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
PauseRolloutRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public PauseRolloutRequest.Builder setProjectBytes(ByteString value)

Required. 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
PauseRolloutRequest.Builder

This builder for chaining.

setRequestId(String value)

public PauseRolloutRequest.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
PauseRolloutRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public PauseRolloutRequest.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
PauseRolloutRequest.Builder

This builder for chaining.

setRollout(String value)

public PauseRolloutRequest.Builder setRollout(String value)

Required. Name of the Rollout resource to pause.

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

Parameter
Name Description
value String

The rollout to set.

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.

setRolloutBytes(ByteString value)

public PauseRolloutRequest.Builder setRolloutBytes(ByteString value)

Required. Name of the Rollout resource to pause.

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

Parameter
Name Description
value ByteString

The bytes for rollout to set.

Returns
Type Description
PauseRolloutRequest.Builder

This builder for chaining.