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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/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 collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReplaceImageRequest

Returns a new instance of ReplaceImageRequest



3779
3780
3781
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3779

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

Instance Attribute Details

#image_object_id ⇒ String

The ID of the existing image that will be replaced. Corresponds to the JSON property imageObjectId

Returns:

  • (String) 


3762
3763
3764
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3762

def image_object_id
  @image_object_id
end

#image_replace_method ⇒ String

The replacement method. Corresponds to the JSON property imageReplaceMethod

Returns:

  • (String) 


3767
3768
3769
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3767

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 in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.source_uri field. Corresponds to the JSON property uri

Returns:

  • (String) 


3777
3778
3779
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3777

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3784
3785
3786
3787
3788
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3784

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