Interface CreateRolloutRequestOrBuilder (1.30.0)

public interface CreateRolloutRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getParent()

public abstract String getParent()

Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getRequestId()

public abstract String getRequestId()

Optional. A 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. The server will guarantee that for at least 60 minutes since the first request.

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

string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public abstract ByteString getRequestIdBytes()

Optional. A 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. The server will guarantee that for at least 60 minutes since the first request.

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

string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for requestId.

getRollout()

public abstract Rollout getRollout()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Rollout

The rollout.

getRolloutId()

public abstract String getRolloutId()

Required. ID of the Rollout.

string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The rolloutId.

getRolloutIdBytes()

public abstract ByteString getRolloutIdBytes()

Required. ID of the Rollout.

string rollout_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for rolloutId.

getRolloutOrBuilder()

public abstract RolloutOrBuilder getRolloutOrBuilder()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RolloutOrBuilder

getStartingPhaseId()

public abstract String getStartingPhaseId()

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

string starting_phase_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The startingPhaseId.

getStartingPhaseIdBytes()

public abstract ByteString getStartingPhaseIdBytes()

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

string starting_phase_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for startingPhaseId.

getValidateOnly()

public abstract boolean getValidateOnly()

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The validateOnly.

hasRollout()

public abstract boolean hasRollout()

Required. The Rollout to create.

.google.cloud.deploy.v1.Rollout rollout = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the rollout field is set.