Class: Google::Apis::DocsV1::Request

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

A single update to apply to a document.

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) ⇒ Request

Returns a new instance of Request



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

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

Instance Attribute Details

#create_named_rangeGoogle::Apis::DocsV1::CreateNamedRangeRequest

Creates a NamedRange referencing the given range. Corresponds to the JSON property createNamedRange



3649
3650
3651
# File 'generated/google/apis/docs_v1/classes.rb', line 3649

def create_named_range
  @create_named_range
end

#create_paragraph_bulletsGoogle::Apis::DocsV1::CreateParagraphBulletsRequest

Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. Corresponds to the JSON property createParagraphBullets



3661
3662
3663
# File 'generated/google/apis/docs_v1/classes.rb', line 3661

def create_paragraph_bullets
  @create_paragraph_bullets
end

#delete_content_rangeGoogle::Apis::DocsV1::DeleteContentRangeRequest

Deletes content from the document. Corresponds to the JSON property deleteContentRange



3666
3667
3668
# File 'generated/google/apis/docs_v1/classes.rb', line 3666

def delete_content_range
  @delete_content_range
end

#delete_named_rangeGoogle::Apis::DocsV1::DeleteNamedRangeRequest

Deletes a NamedRange. Corresponds to the JSON property deleteNamedRange



3671
3672
3673
# File 'generated/google/apis/docs_v1/classes.rb', line 3671

def delete_named_range
  @delete_named_range
end

#delete_paragraph_bulletsGoogle::Apis::DocsV1::DeleteParagraphBulletsRequest

Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. Corresponds to the JSON property deleteParagraphBullets



3678
3679
3680
# File 'generated/google/apis/docs_v1/classes.rb', line 3678

def delete_paragraph_bullets
  @delete_paragraph_bullets
end

#delete_positioned_objectGoogle::Apis::DocsV1::DeletePositionedObjectRequest

Deletes a PositionedObject from the document. Corresponds to the JSON property deletePositionedObject



3684
3685
3686
# File 'generated/google/apis/docs_v1/classes.rb', line 3684

def delete_positioned_object
  @delete_positioned_object
end

#delete_table_columnGoogle::Apis::DocsV1::DeleteTableColumnRequest

Deletes a column from a table. Corresponds to the JSON property deleteTableColumn



3689
3690
3691
# File 'generated/google/apis/docs_v1/classes.rb', line 3689

def delete_table_column
  @delete_table_column
end

#delete_table_rowGoogle::Apis::DocsV1::DeleteTableRowRequest

Deletes a row from a table. Corresponds to the JSON property deleteTableRow



3694
3695
3696
# File 'generated/google/apis/docs_v1/classes.rb', line 3694

def delete_table_row
  @delete_table_row
end

#insert_inline_imageGoogle::Apis::DocsV1::InsertInlineImageRequest

Inserts an InlineObject containing an image at the given location. Corresponds to the JSON property insertInlineImage



3700
3701
3702
# File 'generated/google/apis/docs_v1/classes.rb', line 3700

def insert_inline_image
  @insert_inline_image
end

#insert_page_breakGoogle::Apis::DocsV1::InsertPageBreakRequest

Inserts a page break followed by a newline at the specified location. Corresponds to the JSON property insertPageBreak



3705
3706
3707
# File 'generated/google/apis/docs_v1/classes.rb', line 3705

def insert_page_break
  @insert_page_break
end

#insert_tableGoogle::Apis::DocsV1::InsertTableRequest

Inserts a table at the specified location. A newline character will be inserted before the inserted table. Corresponds to the JSON property insertTable



3711
3712
3713
# File 'generated/google/apis/docs_v1/classes.rb', line 3711

def insert_table
  @insert_table
end

#insert_table_columnGoogle::Apis::DocsV1::InsertTableColumnRequest

Inserts an empty column into a table. Corresponds to the JSON property insertTableColumn



3716
3717
3718
# File 'generated/google/apis/docs_v1/classes.rb', line 3716

def insert_table_column
  @insert_table_column
end

#insert_table_rowGoogle::Apis::DocsV1::InsertTableRowRequest

Inserts an empty row into a table. Corresponds to the JSON property insertTableRow



3721
3722
3723
# File 'generated/google/apis/docs_v1/classes.rb', line 3721

def insert_table_row
  @insert_table_row
end

#insert_textGoogle::Apis::DocsV1::InsertTextRequest

Inserts text at the specified location. Corresponds to the JSON property insertText



3726
3727
3728
# File 'generated/google/apis/docs_v1/classes.rb', line 3726

def insert_text
  @insert_text
end

#replace_all_textGoogle::Apis::DocsV1::ReplaceAllTextRequest

Replaces all instances of text matching a criteria with replace text. Corresponds to the JSON property replaceAllText



3731
3732
3733
# File 'generated/google/apis/docs_v1/classes.rb', line 3731

def replace_all_text
  @replace_all_text
end

#update_document_styleGoogle::Apis::DocsV1::UpdateDocumentStyleRequest

Updates the DocumentStyle. Corresponds to the JSON property updateDocumentStyle



3736
3737
3738
# File 'generated/google/apis/docs_v1/classes.rb', line 3736

def update_document_style
  @update_document_style
end

#update_paragraph_styleGoogle::Apis::DocsV1::UpdateParagraphStyleRequest

Update the styling of all paragraphs that overlap with the given range. Corresponds to the JSON property updateParagraphStyle



3741
3742
3743
# File 'generated/google/apis/docs_v1/classes.rb', line 3741

def update_paragraph_style
  @update_paragraph_style
end

#update_table_cell_styleGoogle::Apis::DocsV1::UpdateTableCellStyleRequest

Updates the style of a range of table cells. Corresponds to the JSON property updateTableCellStyle



3746
3747
3748
# File 'generated/google/apis/docs_v1/classes.rb', line 3746

def update_table_cell_style
  @update_table_cell_style
end

#update_table_column_propertiesGoogle::Apis::DocsV1::UpdateTableColumnPropertiesRequest

Updates the TableColumnProperties of columns in a table. Corresponds to the JSON property updateTableColumnProperties



3753
3754
3755
# File 'generated/google/apis/docs_v1/classes.rb', line 3753

def update_table_column_properties
  @update_table_column_properties
end

#update_table_row_styleGoogle::Apis::DocsV1::UpdateTableRowStyleRequest

Updates the TableRowStyle of rows in a table. Corresponds to the JSON property updateTableRowStyle



3759
3760
3761
# File 'generated/google/apis/docs_v1/classes.rb', line 3759

def update_table_row_style
  @update_table_row_style
end

#update_text_styleGoogle::Apis::DocsV1::UpdateTextStyleRequest

Update the styling of text. Corresponds to the JSON property updateTextStyle



3764
3765
3766
# File 'generated/google/apis/docs_v1/classes.rb', line 3764

def update_text_style
  @update_text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
# File 'generated/google/apis/docs_v1/classes.rb', line 3771

def update!(**args)
  @create_named_range = args[:create_named_range] if args.key?(:create_named_range)
  @create_paragraph_bullets = args[:create_paragraph_bullets] if args.key?(:create_paragraph_bullets)
  @delete_content_range = args[:delete_content_range] if args.key?(:delete_content_range)
  @delete_named_range = args[:delete_named_range] if args.key?(:delete_named_range)
  @delete_paragraph_bullets = args[:delete_paragraph_bullets] if args.key?(:delete_paragraph_bullets)
  @delete_positioned_object = args[:delete_positioned_object] if args.key?(:delete_positioned_object)
  @delete_table_column = args[:delete_table_column] if args.key?(:delete_table_column)
  @delete_table_row = args[:delete_table_row] if args.key?(:delete_table_row)
  @insert_inline_image = args[:insert_inline_image] if args.key?(:insert_inline_image)
  @insert_page_break = args[:insert_page_break] if args.key?(:insert_page_break)
  @insert_table = args[:insert_table] if args.key?(:insert_table)
  @insert_table_column = args[:insert_table_column] if args.key?(:insert_table_column)
  @insert_table_row = args[:insert_table_row] if args.key?(:insert_table_row)
  @insert_text = args[:insert_text] if args.key?(:insert_text)
  @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text)
  @update_document_style = args[:update_document_style] if args.key?(:update_document_style)
  @update_paragraph_style = args[:update_paragraph_style] if args.key?(:update_paragraph_style)
  @update_table_cell_style = args[:update_table_cell_style] if args.key?(:update_table_cell_style)
  @update_table_column_properties = args[:update_table_column_properties] if args.key?(:update_table_column_properties)
  @update_table_row_style = args[:update_table_row_style] if args.key?(:update_table_row_style)
  @update_text_style = args[:update_text_style] if args.key?(:update_text_style)
end