Method: Google::Cloud::VisionAI::V1::AppPlatform::Rest::Client#update_draft

Defined in:

lib/google/cloud/vision_ai/v1/app_platform/rest/client.rb

#update_draft(request, options = nil) ⇒ ::Gapic::Operation #update_draft(update_mask: nil, draft: nil, request_id: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single Draft.

Examples:

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::AppPlatform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::UpdateDraftRequest.new

# Call the update_draft method.
result = client.update_draft request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

• #update_draft(request, options = nil) ⇒ ::Gapic::Operation

  Pass arguments to update_draft via a request object, either of type UpdateDraftRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::VisionAI::V1::UpdateDraftRequest, ::Hash) —

    A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

  • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

• #update_draft(update_mask: nil, draft: nil, request_id: nil, allow_missing: nil) ⇒ ::Gapic::Operation

  Pass arguments to update_draft via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

  Parameters:

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

    Optional. Field mask is used to specify the fields to be overwritten in the Draft resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

  • draft (::Google::Cloud::VisionAI::V1::Draft, ::Hash) (defaults to: nil) —

    Required. The resource being updated.

  • request_id (::String) (defaults to: nil) —

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

  • allow_missing (::Boolean) (defaults to: nil) —

    If true, UpdateDraftRequest will create one resource if the target resource doesn't exist, this time, the field_mask will be ignored.

Yields:

• (result, operation) —

  Access the result along with the TransportOperation object

Yield Parameters:

• result (::Gapic::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns:

• (::Gapic::Operation)

Raises:

• (::Google::Cloud::Error) —

  if the REST call is aborted.

# File 'lib/google/cloud/vision_ai/v1/app_platform/rest/client.rb', line 2091

def update_draft request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VisionAI::V1::UpdateDraftRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_draft.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VisionAI::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_draft.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_draft.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @app_platform_stub.update_draft request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end