Class CreateRolloutRequest.Builder (1.53.0) 

public static final class CreateRolloutRequest.Builder extends GeneratedMessageV3.Builder<CreateRolloutRequest.Builder> implements CreateRolloutRequestOrBuilder

CreateRolloutRequest is the request object used by CreateRollout.

Protobuf type google.cloud.deploy.v1.CreateRolloutRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateRolloutRequest.Builder

Static Methods

getDescriptor()

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

Methods

addAllOverrideDeployPolicy(Iterable<String> values)

public CreateRolloutRequest.Builder addAllOverrideDeployPolicy(Iterable<String> values)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The overrideDeployPolicy to add.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

addOverrideDeployPolicy(String value)

public CreateRolloutRequest.Builder addOverrideDeployPolicy(String value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The overrideDeployPolicy to add.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

addOverrideDeployPolicyBytes(ByteString value)

public CreateRolloutRequest.Builder addOverrideDeployPolicyBytes(ByteString value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the overrideDeployPolicy to add.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateRolloutRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

build()

public CreateRolloutRequest build()
Returns
Type Description
CreateRolloutRequest

buildPartial()

public CreateRolloutRequest buildPartial()
Returns
Type Description
CreateRolloutRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public CreateRolloutRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateRolloutRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

clearOverrideDeployPolicy()

public CreateRolloutRequest.Builder clearOverrideDeployPolicy()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

clearParent()

public CreateRolloutRequest.Builder clearParent()

Required. The parent collection in which the Rollout must be created. The format is 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
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

clearRequestId()

public CreateRolloutRequest.Builder clearRequestId()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

clearRollout()

public CreateRolloutRequest.Builder clearRollout()

Required. The Rollout to create.

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

Returns
Type Description
CreateRolloutRequest.Builder

clearRolloutId()

public CreateRolloutRequest.Builder clearRolloutId()

Required. ID of the Rollout.

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

Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

clearStartingPhaseId()

public CreateRolloutRequest.Builder clearStartingPhaseId()

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

This builder for chaining.

clearValidateOnly()

public CreateRolloutRequest.Builder clearValidateOnly()

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

This builder for chaining.

clone()

public CreateRolloutRequest.Builder clone()
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateRolloutRequest getDefaultInstanceForType()
Returns
Type Description
CreateRolloutRequest

getDescriptorForType()

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

getOverrideDeployPolicy(int index)

public String getOverrideDeployPolicy(int index)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The overrideDeployPolicy at the given index.

getOverrideDeployPolicyBytes(int index)

public ByteString getOverrideDeployPolicyBytes(int index)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the overrideDeployPolicy at the given index.

getOverrideDeployPolicyCount()

public int getOverrideDeployPolicyCount()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of overrideDeployPolicy.

getOverrideDeployPolicyList()

public ProtocolStringList getOverrideDeployPolicyList()

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the overrideDeployPolicy.

getParent()

public String getParent()

Required. The parent collection in which the Rollout must be created. The format is 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
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent collection in which the Rollout must be created. The format is 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
Type Description
ByteString

The bytes for parent.

getRequestId()

public String getRequestId()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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
Type Description
ByteString

The bytes for requestId.

getRollout()

public Rollout getRollout()

Required. The Rollout to create.

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

Returns
Type Description
Rollout

The rollout.

getRolloutBuilder()

public Rollout.Builder getRolloutBuilder()

Required. The Rollout to create.

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

Returns
Type Description
Rollout.Builder

getRolloutId()

public String getRolloutId()

Required. ID of the Rollout.

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

Returns
Type Description
String

The rolloutId.

getRolloutIdBytes()

public ByteString getRolloutIdBytes()

Required. ID of the Rollout.

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

Returns
Type Description
ByteString

The bytes for rolloutId.

getRolloutOrBuilder()

public RolloutOrBuilder getRolloutOrBuilder()

Required. The Rollout to create.

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

Returns
Type Description
RolloutOrBuilder

getStartingPhaseId()

public 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
Type Description
String

The startingPhaseId.

getStartingPhaseIdBytes()

public 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
Type Description
ByteString

The bytes for startingPhaseId.

getValidateOnly()

public 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
Type Description
boolean

The validateOnly.

hasRollout()

public boolean hasRollout()

Required. The Rollout to create.

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

Returns
Type Description
boolean

Whether the rollout field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateRolloutRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRollout(Rollout value)

public CreateRolloutRequest.Builder mergeRollout(Rollout value)

Required. The Rollout to create.

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

Parameter
Name Description
value Rollout
Returns
Type Description
CreateRolloutRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateRolloutRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CreateRolloutRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

setOverrideDeployPolicy(int index, String value)

public CreateRolloutRequest.Builder setOverrideDeployPolicy(int index, String value)

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

repeated string override_deploy_policy = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The overrideDeployPolicy to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setParent(String value)

public CreateRolloutRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateRolloutRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

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

public CreateRolloutRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

setRequestId(String value)

public CreateRolloutRequest.Builder setRequestId(String value)

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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];

Parameter
Name Description
value String

The requestId to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateRolloutRequest.Builder setRequestIdBytes(ByteString value)

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setRollout(Rollout value)

public CreateRolloutRequest.Builder setRollout(Rollout value)

Required. The Rollout to create.

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

Parameter
Name Description
value Rollout
Returns
Type Description
CreateRolloutRequest.Builder

setRollout(Rollout.Builder builderForValue)

public CreateRolloutRequest.Builder setRollout(Rollout.Builder builderForValue)

Required. The Rollout to create.

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

Parameter
Name Description
builderForValue Rollout.Builder
Returns
Type Description
CreateRolloutRequest.Builder

setRolloutId(String value)

public CreateRolloutRequest.Builder setRolloutId(String value)

Required. ID of the Rollout.

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

Parameter
Name Description
value String

The rolloutId to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setRolloutIdBytes(ByteString value)

public CreateRolloutRequest.Builder setRolloutIdBytes(ByteString value)

Required. ID of the Rollout.

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

Parameter
Name Description
value ByteString

The bytes for rolloutId to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setStartingPhaseId(String value)

public CreateRolloutRequest.Builder setStartingPhaseId(String value)

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];

Parameter
Name Description
value String

The startingPhaseId to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setStartingPhaseIdBytes(ByteString value)

public CreateRolloutRequest.Builder setStartingPhaseIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for startingPhaseId to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateRolloutRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateRolloutRequest.Builder
Overrides

setValidateOnly(boolean value)

public CreateRolloutRequest.Builder setValidateOnly(boolean value)

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];

Parameter
Name Description
value boolean

The validateOnly to set.
Returns
Type Description
CreateRolloutRequest.Builder

This builder for chaining.