class Google::Apis::DocsV1::Request
A single update to apply to a document.
Attributes
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` @return [Google::Apis::DocsV1::CreateFootnoteRequest]
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` @return [Google::Apis::DocsV1::CreateHeaderRequest]
Creates a NamedRange
referencing the given range. Corresponds to the JSON property `createNamedRange` @return [Google::Apis::DocsV1::CreateNamedRangeRequest]
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` @return [Google::Apis::DocsV1::CreateParagraphBulletsRequest]
Deletes content from the document. Corresponds to the JSON property `deleteContentRange` @return [Google::Apis::DocsV1::DeleteContentRangeRequest]
Deletes a Header
from the document. Corresponds to the JSON property `deleteHeader` @return [Google::Apis::DocsV1::DeleteHeaderRequest]
Deletes a NamedRange
. Corresponds to the JSON property `deleteNamedRange` @return [Google::Apis::DocsV1::DeleteNamedRangeRequest]
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` @return [Google::Apis::DocsV1::DeleteParagraphBulletsRequest]
Deletes a PositionedObject
from the document. Corresponds to the JSON property `deletePositionedObject` @return [Google::Apis::DocsV1::DeletePositionedObjectRequest]
Deletes a column from a table. Corresponds to the JSON property `deleteTableColumn` @return [Google::Apis::DocsV1::DeleteTableColumnRequest]
Deletes a row from a table. Corresponds to the JSON property `deleteTableRow` @return [Google::Apis::DocsV1::DeleteTableRowRequest]
Inserts an InlineObject
containing an image at the given location. Corresponds to the JSON property `insertInlineImage` @return [Google::Apis::DocsV1::InsertInlineImageRequest]
Inserts a page break followed by a newline at the specified location. Corresponds to the JSON property `insertPageBreak` @return [Google::Apis::DocsV1::InsertPageBreakRequest]
Inserts a section break at the given location. A newline character will be inserted before the section break. Corresponds to the JSON property `insertSectionBreak` @return [Google::Apis::DocsV1::InsertSectionBreakRequest]
Inserts a table at the specified location. A newline character will be inserted before the inserted table. Corresponds to the JSON property `insertTable` @return [Google::Apis::DocsV1::InsertTableRequest]
Inserts an empty column into a table. Corresponds to the JSON property `insertTableColumn` @return [Google::Apis::DocsV1::InsertTableColumnRequest]
Inserts an empty row into a table. Corresponds to the JSON property `insertTableRow` @return [Google::Apis::DocsV1::InsertTableRowRequest]
Inserts text at the specified location. Corresponds to the JSON property `insertText` @return [Google::Apis::DocsV1::InsertTextRequest]
Merges cells in a Table
. Corresponds to the JSON property `mergeTableCells` @return [Google::Apis::DocsV1::MergeTableCellsRequest]
Replaces all instances of text matching a criteria with replace text. Corresponds to the JSON property `replaceAllText` @return [Google::Apis::DocsV1::ReplaceAllTextRequest]
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` @return [Google::Apis::DocsV1::ReplaceImageRequest]
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` @return [Google::Apis::DocsV1::ReplaceNamedRangeContentRequest]
Unmerges cells in a Table
. Corresponds to the JSON property `unmergeTableCells` @return [Google::Apis::DocsV1::UnmergeTableCellsRequest]
Updates the DocumentStyle
. Corresponds to the JSON property `updateDocumentStyle` @return [Google::Apis::DocsV1::UpdateDocumentStyleRequest]
Update the styling of all paragraphs that overlap with the given range. Corresponds to the JSON property `updateParagraphStyle` @return [Google::Apis::DocsV1::UpdateParagraphStyleRequest]
Updates the SectionStyle
. Corresponds to the JSON property `updateSectionStyle` @return [Google::Apis::DocsV1::UpdateSectionStyleRequest]
Updates the style of a range of table cells. Corresponds to the JSON property `updateTableCellStyle` @return [Google::Apis::DocsV1::UpdateTableCellStyleRequest]
Updates the TableColumnProperties
of columns in a table. Corresponds to the JSON property `updateTableColumnProperties` @return [Google::Apis::DocsV1::UpdateTableColumnPropertiesRequest]
Updates the TableRowStyle
of rows in a table. Corresponds to the JSON property `updateTableRowStyle` @return [Google::Apis::DocsV1::UpdateTableRowStyleRequest]
Update the styling of text. Corresponds to the JSON property `updateTextStyle` @return [Google::Apis::DocsV1::UpdateTextStyleRequest]
Public Class Methods
# File lib/google/apis/docs_v1/classes.rb, line 4136 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/docs_v1/classes.rb, line 4141 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