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.



3976
3977
3978
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3976

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) 


3959
3960
3961
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3959

def image_object_id
  @image_object_id
end

#image_replace_method ⇒ String

The replacement method. Corresponds to the JSON property imageReplaceMethod

Returns:

  • (String) 


3964
3965
3966
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3964

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) 


3974
3975
3976
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3974

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3981
3982
3983
3984
3985
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3981

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