Reference documentation and code samples for the Service Usage V1 API class Google::Api::Page.
Represents a documentation page. A page can contain subpages to represent
nested documentation set structure.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#content
defcontent()->::String
Returns
(::String) — 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.
#content=
defcontent=(value)->::String
Parameter
value(::String) — 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.
Returns
(::String) — 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.
#name
defname()->::String
Returns
(::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 referenceJavapage using Markdown reference link syntax:[Java][Tutorial.Java].
#name=
defname=(value)->::String
Parameter
value(::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 referenceJavapage using Markdown reference link syntax:[Java][Tutorial.Java].
Returns
(::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 referenceJavapage using Markdown reference link syntax:[Java][Tutorial.Java].
#subpages
defsubpages()->::Array<::Google::Api::Page>
Returns
(::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
#subpages=
defsubpages=(value)->::Array<::Google::Api::Page>
Parameter
value(::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
Returns
(::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Service Usage V1 API - Class Google::Api::Page (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-service_usage-v1/latest/Google-Api-Page)\n- [1.2.1](/ruby/docs/reference/google-cloud-service_usage-v1/1.2.1/Google-Api-Page)\n- [1.1.0](/ruby/docs/reference/google-cloud-service_usage-v1/1.1.0/Google-Api-Page)\n- [1.0.1](/ruby/docs/reference/google-cloud-service_usage-v1/1.0.1/Google-Api-Page)\n- [0.7.0](/ruby/docs/reference/google-cloud-service_usage-v1/0.7.0/Google-Api-Page)\n- [0.6.2](/ruby/docs/reference/google-cloud-service_usage-v1/0.6.2/Google-Api-Page)\n- [0.5.0](/ruby/docs/reference/google-cloud-service_usage-v1/0.5.0/Google-Api-Page)\n- [0.4.0](/ruby/docs/reference/google-cloud-service_usage-v1/0.4.0/Google-Api-Page)\n- [0.3.1](/ruby/docs/reference/google-cloud-service_usage-v1/0.3.1/Google-Api-Page)\n- [0.2.1](/ruby/docs/reference/google-cloud-service_usage-v1/0.2.1/Google-Api-Page)\n- [0.1.4](/ruby/docs/reference/google-cloud-service_usage-v1/0.1.4/Google-Api-Page) \nReference documentation and code samples for the Service Usage V1 API class Google::Api::Page.\n\nRepresents a documentation page. A page can contain subpages to represent\nnested documentation set structure. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #content\n\n def content() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The Markdown content of the page. You can use `(== include {path}\n ==)` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.\n\n### #content=\n\n def content=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The Markdown content of the page. You can use `(== include {path}\n==)` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page. \n**Returns**\n\n- (::String) --- The Markdown content of the page. You can use `(== include {path}\n ==)` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::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:\n\n\n pages:\n - name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\n You can reference `Java` page using Markdown reference link syntax:\n `[Java][Tutorial.Java]`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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:\n\n\n pages:\n - name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\n You can reference `Java` page using Markdown reference link syntax:\n`[Java][Tutorial.Java]`. \n**Returns**\n\n- (::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:\n\n\n pages:\n - name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\n You can reference `Java` page using Markdown reference link syntax:\n `[Java][Tutorial.Java]`.\n\n### #subpages\n\n def subpages() -\u003e ::Array\u003c::Google::Api::Page\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Api::Page](./Google-Api-Page)\\\u003e) --- Subpages of this page. The order of subpages specified here will be honored in the generated docset.\n\n### #subpages=\n\n def subpages=(value) -\u003e ::Array\u003c::Google::Api::Page\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Api::Page](./Google-Api-Page)\\\u003e) --- Subpages of this page. The order of subpages specified here will be honored in the generated docset. \n**Returns**\n\n- (::Array\\\u003c[::Google::Api::Page](./Google-Api-Page)\\\u003e) --- Subpages of this page. The order of subpages specified here will be honored in the generated docset."]]
