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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/google/apis/docs_v1/representations.rb

Overview

A single update to apply to a document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Request

Returns a new instance of Request.



4510
4511
4512
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4510

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 specified, 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

Returns:



4326
4327
4328
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4326

def create_footer
  @create_footer
end

#create_footnote ⇒ Google::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

Returns:



4333
4334
4335
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4333

def create_footnote
  @create_footnote
end

#create_header ⇒ Google::Apis::DocsV1::CreateHeaderRequest

Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, 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

Returns:



4341
4342
4343
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4341

def create_header
  @create_header
end

#create_named_range ⇒ Google::Apis::DocsV1::CreateNamedRangeRequest

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

Returns:



4346
4347
4348
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4346

def create_named_range
  @create_named_range
end

#create_paragraph_bullets ⇒ Google::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

Returns:



4357
4358
4359
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4357

def create_paragraph_bullets
  @create_paragraph_bullets
end

#delete_content_range ⇒ Google::Apis::DocsV1::DeleteContentRangeRequest

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

Returns:



4362
4363
4364
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4362

def delete_content_range
  @delete_content_range
end

#delete_footer ⇒ Google::Apis::DocsV1::DeleteFooterRequest

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

Returns:



4367
4368
4369
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4367

def delete_footer
  @delete_footer
end

#delete_header ⇒ Google::Apis::DocsV1::DeleteHeaderRequest

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

Returns:



4372
4373
4374
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4372

def delete_header
  @delete_header
end

#delete_named_range ⇒ Google::Apis::DocsV1::DeleteNamedRangeRequest

Deletes a NamedRange. Corresponds to the JSON property deleteNamedRange

Returns:



4377
4378
4379
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4377

def delete_named_range
  @delete_named_range
end

#delete_paragraph_bullets ⇒ Google::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

Returns:



4384
4385
4386
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4384

def delete_paragraph_bullets
  @delete_paragraph_bullets
end

#delete_positioned_object ⇒ Google::Apis::DocsV1::DeletePositionedObjectRequest

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

Returns:



4389
4390
4391
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4389

def delete_positioned_object
  @delete_positioned_object
end

#delete_table_column ⇒ Google::Apis::DocsV1::DeleteTableColumnRequest

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

Returns:



4394
4395
4396
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4394

def delete_table_column
  @delete_table_column
end

#delete_table_row ⇒ Google::Apis::DocsV1::DeleteTableRowRequest

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

Returns:



4399
4400
4401
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4399

def delete_table_row
  @delete_table_row
end

#insert_inline_image ⇒ Google::Apis::DocsV1::InsertInlineImageRequest

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

Returns:



4404
4405
4406
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4404

def insert_inline_image
  @insert_inline_image
end

#insert_page_break ⇒ Google::Apis::DocsV1::InsertPageBreakRequest

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

Returns:



4409
4410
4411
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4409

def insert_page_break
  @insert_page_break
end

#insert_section_break ⇒ Google::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

Returns:



4415
4416
4417
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4415

def insert_section_break
  @insert_section_break
end

#insert_table ⇒ Google::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

Returns:



4421
4422
4423
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4421

def insert_table
  @insert_table
end

#insert_table_column ⇒ Google::Apis::DocsV1::InsertTableColumnRequest

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

Returns:



4426
4427
4428
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4426

def insert_table_column
  @insert_table_column
end

#insert_table_row ⇒ Google::Apis::DocsV1::InsertTableRowRequest

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

Returns:



4431
4432
4433
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4431

def insert_table_row
  @insert_table_row
end

#insert_text ⇒ Google::Apis::DocsV1::InsertTextRequest

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

Returns:



4436
4437
4438
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4436

def insert_text
  @insert_text
end

#merge_table_cells ⇒ Google::Apis::DocsV1::MergeTableCellsRequest

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

Returns:



4441
4442
4443
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4441

def merge_table_cells
  @merge_table_cells
end

#pin_table_header_rows ⇒ Google::Apis::DocsV1::PinTableHeaderRowsRequest

Updates the number of pinned table header rows in a table. Corresponds to the JSON property pinTableHeaderRows

Returns:



4446
4447
4448
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4446

def pin_table_header_rows
  @pin_table_header_rows
end

#replace_all_text ⇒ Google::Apis::DocsV1::ReplaceAllTextRequest

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

Returns:



4451
4452
4453
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4451

def replace_all_text
  @replace_all_text
end

#replace_image ⇒ Google::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

Returns:



4458
4459
4460
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4458

def replace_image
  @replace_image
end

#replace_named_range_content ⇒ Google::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

Returns:



4468
4469
4470
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4468

def replace_named_range_content
  @replace_named_range_content
end

#unmerge_table_cells ⇒ Google::Apis::DocsV1::UnmergeTableCellsRequest

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

Returns:



4473
4474
4475
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4473

def unmerge_table_cells
  @unmerge_table_cells
end

#update_document_style ⇒ Google::Apis::DocsV1::UpdateDocumentStyleRequest

Updates the DocumentStyle. Corresponds to the JSON property updateDocumentStyle

Returns:



4478
4479
4480
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4478

def update_document_style
  @update_document_style
end

#update_paragraph_style ⇒ Google::Apis::DocsV1::UpdateParagraphStyleRequest

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

Returns:



4483
4484
4485
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4483

def update_paragraph_style
  @update_paragraph_style
end

#update_section_style ⇒ Google::Apis::DocsV1::UpdateSectionStyleRequest

Updates the SectionStyle. Corresponds to the JSON property updateSectionStyle

Returns:



4488
4489
4490
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4488

def update_section_style
  @update_section_style
end

#update_table_cell_style ⇒ Google::Apis::DocsV1::UpdateTableCellStyleRequest

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

Returns:



4493
4494
4495
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4493

def update_table_cell_style
  @update_table_cell_style
end

#update_table_column_properties ⇒ Google::Apis::DocsV1::UpdateTableColumnPropertiesRequest

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

Returns:



4498
4499
4500
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4498

def update_table_column_properties
  @update_table_column_properties
end

#update_table_row_style ⇒ Google::Apis::DocsV1::UpdateTableRowStyleRequest

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

Returns:



4503
4504
4505
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4503

def update_table_row_style
  @update_table_row_style
end

#update_text_style ⇒ Google::Apis::DocsV1::UpdateTextStyleRequest

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

Returns:



4508
4509
4510
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4508

def update_text_style
  @update_text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4515

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)
  @pin_table_header_rows = args[:pin_table_header_rows] if args.key?(:pin_table_header_rows)
  @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