Class: Google::Apis::DocsV1::ReplaceImageRequest

Inherits:

Object

• Object
• Google::Apis::DocsV1::ReplaceImageRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/google/apis/docs_v1/representations.rb

Overview

Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor.

Instance Attribute Summary

• #image_object_id ⇒ String

  The ID of the existing image that will be replaced.

• #image_replace_method ⇒ String

  The replacement method.

• #uri ⇒ String

  The URI of the new image.

Instance Method Summary

• #initialize(**args) ⇒ ReplaceImageRequest constructor

  A new instance of ReplaceImageRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ ReplaceImageRequest

Returns a new instance of ReplaceImageRequest.

# File 'lib/google/apis/docs_v1/classes.rb', line 3936

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#image_object_id ⇒ String

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. Corresponds to the JSON property imageObjectId

Returns:

• (String)

# File 'lib/google/apis/docs_v1/classes.rb', line 3920

def image_object_id
  @image_object_id
end

#image_replace_method ⇒ String

The replacement method. Corresponds to the JSON property imageReplaceMethod

Returns:

• (String)

# File 'lib/google/apis/docs_v1/classes.rb', line 3925

def image_replace_method
  @image_replace_method
end

#uri ⇒ String

The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. Corresponds to the JSON property uri

Returns:

• (String)

# File 'lib/google/apis/docs_v1/classes.rb', line 3934

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/docs_v1/classes.rb', line 3941

def update!(**args)
  @image_object_id = args[:image_object_id] if args.key?(:image_object_id)
  @image_replace_method = args[:image_replace_method] if args.key?(:image_replace_method)
  @uri = args[:uri] if args.key?(:uri)
end