class Google::Apis::ServicenetworkingV1beta::Page

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Attributes

content[RW]

The Markdown content of the page. You can use (== include `path` ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. Corresponds to the JSON property `content` @return [String]

name[RW]

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages:

  • name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java

content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`. Corresponds to the JSON property `name` @return [String]

subpages[RW]

Subpages of this page. The order of subpages specified here will be honored in the generated docset. Corresponds to the JSON property `subpages` @return [Array<Google::Apis::ServicenetworkingV1beta::Page>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/servicenetworking_v1beta/classes.rb, line 2591
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/servicenetworking_v1beta/classes.rb, line 2596
def update!(**args)
  @content = args[:content] if args.key?(:content)
  @name = args[:name] if args.key?(:name)
  @subpages = args[:subpages] if args.key?(:subpages)
end