Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::CreateRolloutRequest (v1.1.0)

Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::CreateRolloutRequest.

CreateRolloutRequest is the request object used by CreateRollout.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#override_deploy_policy

def override_deploy_policy() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

#override_deploy_policy=

def override_deploy_policy=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Returns
  • (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

#parent

def parent() -> ::String
Returns
  • (::String) — 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}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}.
Returns
  • (::String) — 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}.

#request_id

def request_id() -> ::String
Returns
  • (::String) — 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).

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — 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).

Returns
  • (::String) — 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).

#rollout

def rollout() -> ::Google::Cloud::Deploy::V1::Rollout
Returns

#rollout=

def rollout=(value) -> ::Google::Cloud::Deploy::V1::Rollout
Parameter
Returns

#rollout_id

def rollout_id() -> ::String
Returns
  • (::String) — Required. ID of the Rollout.

#rollout_id=

def rollout_id=(value) -> ::String
Parameter
  • value (::String) — Required. ID of the Rollout.
Returns
  • (::String) — Required. ID of the Rollout.

#starting_phase_id

def starting_phase_id() -> ::String
Returns
  • (::String) — Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

#starting_phase_id=

def starting_phase_id=(value) -> ::String
Parameter
  • value (::String) — Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
Returns
  • (::String) — Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

#validate_only

def validate_only() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

#validate_only=

def validate_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
Returns
  • (::Boolean) — Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.