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.



4031
4032
4033
# File 'generated/google/apis/docs_v1/classes.rb', line 4031

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

Instance Attribute Details

Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. Corresponds to the JSON property createFooter



3852
3853
3854
# File 'generated/google/apis/docs_v1/classes.rb', line 3852

def create_footer
  @create_footer
end

#create_footnoteGoogle::Apis::DocsV1::CreateFootnoteRequest

Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character. Corresponds to the JSON property createFootnote



3859
3860
3861
# File 'generated/google/apis/docs_v1/classes.rb', line 3859

def create_footnote
  @create_footnote
end

#create_headerGoogle::Apis::DocsV1::CreateHeaderRequest

Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. Corresponds to the JSON property createHeader



3867
3868
3869
# File 'generated/google/apis/docs_v1/classes.rb', line 3867

def create_header
  @create_header
end

#create_named_rangeGoogle::Apis::DocsV1::CreateNamedRangeRequest

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



3872
3873
3874
# File 'generated/google/apis/docs_v1/classes.rb', line 3872

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



3883
3884
3885
# File 'generated/google/apis/docs_v1/classes.rb', line 3883

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



3888
3889
3890
# File 'generated/google/apis/docs_v1/classes.rb', line 3888

def delete_content_range
  @delete_content_range
end

Deletes a Footer from the document. Corresponds to the JSON property deleteFooter



3893
3894
3895
# File 'generated/google/apis/docs_v1/classes.rb', line 3893

def delete_footer
  @delete_footer
end

#delete_headerGoogle::Apis::DocsV1::DeleteHeaderRequest

Deletes a Header from the document. Corresponds to the JSON property deleteHeader



3898
3899
3900
# File 'generated/google/apis/docs_v1/classes.rb', line 3898

def delete_header
  @delete_header
end

#delete_named_rangeGoogle::Apis::DocsV1::DeleteNamedRangeRequest

Deletes a NamedRange. Corresponds to the JSON property deleteNamedRange



3903
3904
3905
# File 'generated/google/apis/docs_v1/classes.rb', line 3903

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



3910
3911
3912
# File 'generated/google/apis/docs_v1/classes.rb', line 3910

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



3915
3916
3917
# File 'generated/google/apis/docs_v1/classes.rb', line 3915

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



3920
3921
3922
# File 'generated/google/apis/docs_v1/classes.rb', line 3920

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



3925
3926
3927
# File 'generated/google/apis/docs_v1/classes.rb', line 3925

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



3930
3931
3932
# File 'generated/google/apis/docs_v1/classes.rb', line 3930

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



3935
3936
3937
# File 'generated/google/apis/docs_v1/classes.rb', line 3935

def insert_page_break
  @insert_page_break
end

#insert_section_breakGoogle::Apis::DocsV1::InsertSectionBreakRequest

Inserts a section break at the given location. A newline character will be inserted before the section break. Corresponds to the JSON property insertSectionBreak



3941
3942
3943
# File 'generated/google/apis/docs_v1/classes.rb', line 3941

def insert_section_break
  @insert_section_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



3947
3948
3949
# File 'generated/google/apis/docs_v1/classes.rb', line 3947

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



3952
3953
3954
# File 'generated/google/apis/docs_v1/classes.rb', line 3952

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



3957
3958
3959
# File 'generated/google/apis/docs_v1/classes.rb', line 3957

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



3962
3963
3964
# File 'generated/google/apis/docs_v1/classes.rb', line 3962

def insert_text
  @insert_text
end

#merge_table_cellsGoogle::Apis::DocsV1::MergeTableCellsRequest

Merges cells in a Table. Corresponds to the JSON property mergeTableCells



3967
3968
3969
# File 'generated/google/apis/docs_v1/classes.rb', line 3967

def merge_table_cells
  @merge_table_cells
end

#replace_all_textGoogle::Apis::DocsV1::ReplaceAllTextRequest

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



3972
3973
3974
# File 'generated/google/apis/docs_v1/classes.rb', line 3972

def replace_all_text
  @replace_all_text
end

#replace_imageGoogle::Apis::DocsV1::ReplaceImageRequest

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. Corresponds to the JSON property replaceImage



3979
3980
3981
# File 'generated/google/apis/docs_v1/classes.rb', line 3979

def replace_image
  @replace_image
end

#replace_named_range_contentGoogle::Apis::DocsV1::ReplaceNamedRangeContentRequest

Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned. Corresponds to the JSON property replaceNamedRangeContent



3989
3990
3991
# File 'generated/google/apis/docs_v1/classes.rb', line 3989

def replace_named_range_content
  @replace_named_range_content
end

#unmerge_table_cellsGoogle::Apis::DocsV1::UnmergeTableCellsRequest

Unmerges cells in a Table. Corresponds to the JSON property unmergeTableCells



3994
3995
3996
# File 'generated/google/apis/docs_v1/classes.rb', line 3994

def unmerge_table_cells
  @unmerge_table_cells
end

#update_document_styleGoogle::Apis::DocsV1::UpdateDocumentStyleRequest

Updates the DocumentStyle. Corresponds to the JSON property updateDocumentStyle



3999
4000
4001
# File 'generated/google/apis/docs_v1/classes.rb', line 3999

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



4004
4005
4006
# File 'generated/google/apis/docs_v1/classes.rb', line 4004

def update_paragraph_style
  @update_paragraph_style
end

#update_section_styleGoogle::Apis::DocsV1::UpdateSectionStyleRequest

Updates the SectionStyle. Corresponds to the JSON property updateSectionStyle



4009
4010
4011
# File 'generated/google/apis/docs_v1/classes.rb', line 4009

def update_section_style
  @update_section_style
end

#update_table_cell_styleGoogle::Apis::DocsV1::UpdateTableCellStyleRequest

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



4014
4015
4016
# File 'generated/google/apis/docs_v1/classes.rb', line 4014

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



4019
4020
4021
# File 'generated/google/apis/docs_v1/classes.rb', line 4019

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



4024
4025
4026
# File 'generated/google/apis/docs_v1/classes.rb', line 4024

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



4029
4030
4031
# File 'generated/google/apis/docs_v1/classes.rb', line 4029

def update_text_style
  @update_text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
# File 'generated/google/apis/docs_v1/classes.rb', line 4036

def update!(**args)
  @create_footer = args[:create_footer] if args.key?(:create_footer)
  @create_footnote = args[:create_footnote] if args.key?(:create_footnote)
  @create_header = args[:create_header] if args.key?(:create_header)
  @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_footer = args[:delete_footer] if args.key?(:delete_footer)
  @delete_header = args[:delete_header] if args.key?(:delete_header)
  @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_section_break = args[:insert_section_break] if args.key?(:insert_section_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)
  @merge_table_cells = args[:merge_table_cells] if args.key?(:merge_table_cells)
  @replace_all_text = args[:replace_all_text] if args.key?(:replace_all_text)
  @replace_image = args[:replace_image] if args.key?(:replace_image)
  @replace_named_range_content = args[:replace_named_range_content] if args.key?(:replace_named_range_content)
  @unmerge_table_cells = args[:unmerge_table_cells] if args.key?(:unmerge_table_cells)
  @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_section_style = args[:update_section_style] if args.key?(:update_section_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