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.



4016
4017
4018
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4016

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

Instance Attribute Details

Creates a Footer. The new footer will be applied to SectionStyle or the DocumentStyle. If a footer of the specified type already exists then a 400 bad request error will be returned. Corresponds to the JSON property createFooter

Returns:



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

def create_footer
  @create_footer
end

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

Creates a Header. The new header will be applied to SectionStyle or the DocumentStyle. If a header of the specified type already exists then a 400 bad request error will be returned. Corresponds to the JSON property createHeader

Returns:



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

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:



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

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:



3878
3879
3880
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3878

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:



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

def delete_content_range
  @delete_content_range
end

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

Deletes a NamedRange. Corresponds to the JSON property deleteNamedRange

Returns:



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

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:



3895
3896
3897
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3895

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:



3901
3902
3903
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3901

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:



3906
3907
3908
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3906

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:



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

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:



3917
3918
3919
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3917

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:



3922
3923
3924
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3922

def insert_page_break
  @insert_page_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:



3928
3929
3930
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3928

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:



3933
3934
3935
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3933

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:



3938
3939
3940
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3938

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:



3943
3944
3945
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3943

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:



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

def merge_table_cells
  @merge_table_cells
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:



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

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:



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

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:



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

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:



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

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:



3986
3987
3988
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3986

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:



3991
3992
3993
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3991

def update_paragraph_style
  @update_paragraph_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:



3996
3997
3998
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3996

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:



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

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:



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

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:



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

def update_text_style
  @update_text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4021

def update!(**args)
  @create_footer = args[:create_footer] if args.key?(:create_footer)
  @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_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)
  @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_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