Class: Google::Cloud::Deploy::V1::CreateRolloutRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/deploy/v1/cloud_deploy.rb

Overview

CreateRolloutRequest is the request object used by CreateRollout.

Instance Attribute Summary collapse

Instance Attribute Details

#parent ⇒ ::String

Returns 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}.

Returns:

  • (::String) —

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



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

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



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rollout ⇒ ::Google::Cloud::Deploy::V1::Rollout

Returns Required. The Rollout to create.

Returns:



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rollout_id ⇒ ::String

Returns Required. ID of the Rollout.

Returns:

  • (::String) —

    Required. ID of the Rollout.



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#starting_phase_id ⇒ ::String

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



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#validate_only ⇒ ::Boolean

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



2518
2519
2520
2521
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2518

class CreateRolloutRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end