Class: Google::Apis::ServiceusageV1::Page
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1::Page
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb
Overview
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
Instance Attribute Summary collapse
-
#content ⇒ String
The Markdown content of the page.
-
#name ⇒ String
The name of the page.
-
#subpages ⇒ Array<Google::Apis::ServiceusageV1::Page>
Subpages of this page.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Page
constructor
A new instance of Page.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Page
Returns a new instance of Page
3202 3203 3204 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3202 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content ⇒ String
The Markdown content of the page. You can use (== include
to include content from a Markdown file.
Corresponds to the JSON property path
==)content
3176 3177 3178 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3176 def content @content end |
#name ⇒ String
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
3194 3195 3196 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3194 def name @name end |
#subpages ⇒ Array<Google::Apis::ServiceusageV1::Page>
Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
Corresponds to the JSON property subpages
3200 3201 3202 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3200 def subpages @subpages end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3207 3208 3209 3210 3211 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3207 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 |